src/main/io/displayport_crsf.c

   1 /*
   2  * This file is part of Cleanflight and Betaflight.
   3  *
   4  * Cleanflight and Betaflight are free software. You can redistribute
   5  * this software and/or modify this software under the terms of the
   6  * GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option)
   8  * any later version.
   9  *
  10  * Cleanflight and Betaflight are distributed in the hope that they
  11  * will be useful, but WITHOUT ANY WARRANTY; without even the implied
  12  * warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  13  * See the GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this software.
  17  *
  18  * If not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #include <stdbool.h>
  22 #include <string.h>
  23
  24 #include "platform.h"
  25
  26 #if defined(USE_CRSF_CMS_TELEMETRY)
  27
  28 #include "cms/cms.h"
  29
  30 #include "common/maths.h"
  31 #include "common/printf.h"
  32 #include "common/time.h"
  33
  34 #include "drivers/display.h"
  35 #include "drivers/time.h"
  36
  37 #include "displayport_crsf.h"
  38
  39 #define CRSF_DISPLAY_PORT_OPEN_DELAY_MS     400
  40 #define CRSF_DISPLAY_PORT_CLEAR_DELAY_MS    45
  41
  42 static crsfDisplayPortScreen_t crsfScreen;
  43 static timeMs_t delayTransportUntilMs = 0;
  44
  45 displayPort_t crsfDisplayPort;
  46
  47 static int crsfGrab(displayPort_t *displayPort)
  48 {
  49     return displayPort->grabCount = 1;
  50 }
  51
  52 static int crsfClearScreen(displayPort_t *displayPort, displayClearOption_e options)
  53 {
  54     UNUSED(displayPort);
  55     UNUSED(options);
  56     memset(crsfScreen.buffer, ' ', sizeof(crsfScreen.buffer));
  57     crsfScreen.updated = false;
  58     crsfScreen.reset = true;
  59     delayTransportUntilMs = millis() + CRSF_DISPLAY_PORT_CLEAR_DELAY_MS;
  60     return 0;
  61 }
  62
  63 static int crsfRelease(displayPort_t *displayPort)
  64 {
  65     displayPort->grabCount = 0;
  66     return crsfClearScreen(displayPort, DISPLAY_CLEAR_WAIT);
  67 }
  68
  69 static bool crsfDrawScreen(displayPort_t *displayPort)
  70 {
  71     UNUSED(displayPort);
  72     return 0;
  73 }
  74
  75 static int crsfScreenSize(const displayPort_t *displayPort)
  76 {
  77     return displayPort->rows * displayPort->cols;
  78 }
  79
  80
  81 static int crsfWriteString(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, const char *s)
  82 {
  83     UNUSED(displayPort);
  84     UNUSED(attr);
  85     if (row >= crsfScreen.rows || col >= crsfScreen.cols) {
  86         return 0;
  87     }
  88     const size_t truncLen = MIN((int)strlen(s), crsfScreen.cols-col);  // truncate at colCount
  89     char *rowStart = &crsfScreen.buffer[row * crsfScreen.cols + col];
  90     crsfScreen.updated |= memcmp(rowStart, s, truncLen);
  91     if (crsfScreen.updated) {
  92         memcpy(rowStart, s, truncLen);
  93     }
  94     return 0;
  95 }
  96
  97 static int crsfWriteChar(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, uint8_t c)
  98 {
  99     char s[1];
 100     tfp_sprintf(s, "%c", c);
 101     return crsfWriteString(displayPort, col, row, attr, s);
 102 }
 103
 104 static bool crsfIsTransferInProgress(const displayPort_t *displayPort)
 105 {
 106     UNUSED(displayPort);
 107     return false;
 108 }
 109
 110 static bool crsfIsSynced(const displayPort_t *displayPort)
 111 {
 112     UNUSED(displayPort);
 113     return true;
 114 }
 115
 116 static int crsfHeartbeat(displayPort_t *displayPort)
 117 {
 118     UNUSED(displayPort);
 119     return 0;
 120 }
 121
 122 static void crsfRedraw(displayPort_t *displayPort)
 123 {
 124     displayPort->rows = crsfScreen.rows;
 125     displayPort->cols = crsfScreen.cols;
 126 }
 127
 128 static uint32_t crsfTxBytesFree(const displayPort_t *displayPort)
 129 {
 130     UNUSED(displayPort);
 131     return UINT32_MAX;
 132 }
 133
 134 static const displayPortVTable_t crsfDisplayPortVTable = {
 135     .grab = crsfGrab,
 136     .release = crsfRelease,
 137     .clearScreen = crsfClearScreen,
 138     .drawScreen = crsfDrawScreen,
 139     .screenSize = crsfScreenSize,
 140     .writeString = crsfWriteString,
 141     .writeChar = crsfWriteChar,
 142     .isTransferInProgress = crsfIsTransferInProgress,
 143     .heartbeat = crsfHeartbeat,
 144     .redraw = crsfRedraw,
 145     .isSynced = crsfIsSynced,
 146     .txBytesFree = crsfTxBytesFree,
 147     .layerSupported = NULL,
 148     .layerSelect = NULL,
 149     .layerCopy = NULL,
 150 };
 151
 152 crsfDisplayPortScreen_t *crsfDisplayPortScreen(void)
 153 {
 154     return &crsfScreen;
 155 }
 156
 157 void crsfDisplayPortMenuOpen(void)
 158 {
 159     if (cmsInMenu) {
 160         return;
 161     }
 162     if (cmsDisplayPortSelect(&crsfDisplayPort)) {
 163         cmsMenuOpen();
 164         delayTransportUntilMs = millis() + CRSF_DISPLAY_PORT_OPEN_DELAY_MS;
 165     }
 166 }
 167
 168 void crsfDisplayPortMenuExit(void)
 169 {
 170     if (!cmsInMenu) {
 171         return;
 172     }
 173     uint8_t exitMenu = CMS_EXIT;
 174     cmsMenuExit(&crsfDisplayPort, &exitMenu);
 175 }
 176
 177 void crsfDisplayPortSetDimensions(uint8_t rows, uint8_t cols)
 178 {
 179     crsfScreen.rows = MIN(rows, CRSF_DISPLAY_PORT_ROWS_MAX);
 180     crsfScreen.cols = MIN(cols, CRSF_DISPLAY_PORT_COLS_MAX);
 181     crsfRedraw(&crsfDisplayPort);
 182 }
 183
 184 void crsfDisplayPortRefresh(void)
 185 {
 186     if (!cmsInMenu) {
 187         crsfDisplayPortMenuOpen();
 188         return;
 189     }
 190     crsfScreen.updated = true;
 191     crsfScreen.reset = true;
 192     delayTransportUntilMs = millis() + CRSF_DISPLAY_PORT_CLEAR_DELAY_MS;
 193 }
 194
 195 bool crsfDisplayPortIsReady(void)
 196 {
 197     const timeMs_t currentTimeMs = millis();
 198     const bool delayExpired = (currentTimeMs > delayTransportUntilMs);
 199     const bool cmsReady = (cmsInMenu && (pCurrentDisplay == &crsfDisplayPort));
 200     return (bool)(delayExpired && cmsReady);
 201 }
 202
 203 static displayPort_t *displayPortCrsfInit()
 204 {
 205     crsfDisplayPortSetDimensions(CRSF_DISPLAY_PORT_ROWS_MAX, CRSF_DISPLAY_PORT_COLS_MAX);
 206     displayInit(&crsfDisplayPort, &crsfDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_CRSF);
 207
 208     return &crsfDisplayPort;
 209 }
 210
 211 void crsfDisplayportRegister(void)
 212 {
 213     cmsDisplayPortRegister(displayPortCrsfInit());
 214 }
 215 #endif