src/main/io/displayport_msp.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 <stdint.h>
  23 #include <string.h>
  24 #include <ctype.h>
  25
  26 #include "platform.h"
  27
  28 #ifdef USE_MSP_DISPLAYPORT
  29
  30 #include "cli/cli.h"
  31
  32 #include "common/utils.h"
  33
  34 #include "drivers/display.h"
  35 #include "drivers/osd.h"
  36
  37 #include "io/displayport_msp.h"
  38
  39 #include "msp/msp.h"
  40 #include "msp/msp_protocol.h"
  41 #include "msp/msp_serial.h"
  42
  43 #include "osd/osd.h"
  44
  45 #include "pg/vcd.h"
  46
  47 static displayPort_t mspDisplayPort;
  48 static serialPortIdentifier_e displayPortSerial;
  49
  50 static int output(displayPort_t *displayPort, uint8_t cmd, uint8_t *buf, int len)
  51 {
  52     UNUSED(displayPort);
  53
  54 #ifdef USE_CLI
  55     // FIXME There should be no dependency on the CLI but mspSerialPush doesn't check for cli mode, and can't because it also shouldn't have a dependency on the CLI.
  56     if (cliMode) {
  57         return 0;
  58     }
  59 #endif
  60     return mspSerialPush(displayPortSerial, cmd, buf, len, MSP_DIRECTION_REPLY, MSP_V1);
  61 }
  62
  63 static int heartbeat(displayPort_t *displayPort)
  64 {
  65     uint8_t subcmd[] = { MSP_DP_HEARTBEAT };
  66
  67     // heartbeat is used to:
  68     // a) ensure display is not released by MW OSD software
  69     // b) prevent OSD Slave boards from displaying a 'disconnected' status.
  70     output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  71
  72     return 0;
  73 }
  74
  75 static int grab(displayPort_t *displayPort)
  76 {
  77     return heartbeat(displayPort);
  78 }
  79
  80 static int release(displayPort_t *displayPort)
  81 {
  82     uint8_t subcmd[] = { MSP_DP_RELEASE };
  83
  84     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  85 }
  86
  87 static int clearScreen(displayPort_t *displayPort, displayClearOption_e options)
  88 {
  89     UNUSED(options);
  90
  91     uint8_t subcmd[] = { MSP_DP_CLEAR_SCREEN };
  92
  93     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  94 }
  95
  96 static bool drawScreen(displayPort_t *displayPort)
  97 {
  98     uint8_t subcmd[] = { MSP_DP_DRAW_SCREEN };
  99     output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
 100
 101     return 0;
 102 }
 103
 104 static int screenSize(const displayPort_t *displayPort)
 105 {
 106     return displayPort->rows * displayPort->cols;
 107 }
 108
 109 static int writeString(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, const char *string)
 110 {
 111 #define MSP_OSD_MAX_STRING_LENGTH 30 // FIXME move this
 112     uint8_t buf[MSP_OSD_MAX_STRING_LENGTH + 4];
 113
 114     int len = strlen(string);
 115     if (len >= MSP_OSD_MAX_STRING_LENGTH) {
 116         len = MSP_OSD_MAX_STRING_LENGTH;
 117     }
 118
 119     buf[0] = MSP_DP_WRITE_STRING;
 120     buf[1] = row;
 121     buf[2] = col;
 122     buf[3] = displayPortProfileMsp()->fontSelection[attr] & ~DISPLAYPORT_MSP_ATTR_BLINK & DISPLAYPORT_MSP_ATTR_MASK;
 123
 124     if (attr & DISPLAYPORT_ATTR_BLINK) {
 125         buf[3] |= DISPLAYPORT_MSP_ATTR_BLINK;
 126     }
 127
 128     memcpy(&buf[4], string, len);
 129
 130     return output(displayPort, MSP_DISPLAYPORT, buf, len + 4);
 131 }
 132
 133 static int writeSys(displayPort_t *displayPort, uint8_t col, uint8_t row, displayPortSystemElement_e systemElement)
 134 {
 135     uint8_t syscmd[4];
 136
 137     syscmd[0] = MSP_DP_SYS;
 138     syscmd[1] = row;
 139     syscmd[2] = col;
 140     syscmd[3] = systemElement;
 141
 142     return output(displayPort, MSP_DISPLAYPORT, syscmd, sizeof(syscmd));
 143 }
 144
 145 static int writeChar(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, uint8_t c)
 146 {
 147     char buf[2];
 148
 149     buf[0] = c;
 150     buf[1] = 0;
 151     return writeString(displayPort, col, row, attr, buf);
 152 }
 153
 154 static bool isTransferInProgress(const displayPort_t *displayPort)
 155 {
 156     UNUSED(displayPort);
 157     return false;
 158 }
 159
 160 static bool isSynced(const displayPort_t *displayPort)
 161 {
 162     UNUSED(displayPort);
 163     return true;
 164 }
 165
 166 static void redraw(displayPort_t *displayPort)
 167 {
 168 #ifdef USE_OSD
 169     if (vcdProfile()->video_system == VIDEO_SYSTEM_HD) {
 170         displayPort->rows = osdConfig()->canvas_rows;
 171         displayPort->cols = osdConfig()->canvas_cols;
 172     } else {
 173         const uint8_t displayRows = (vcdProfile()->video_system == VIDEO_SYSTEM_PAL) ? 16 : 13;
 174         displayPort->rows = displayRows + displayPortProfileMsp()->rowAdjust;
 175         displayPort->cols = 30 + displayPortProfileMsp()->colAdjust;
 176     }
 177 #else
 178     const uint8_t displayRows = (vcdProfile()->video_system == VIDEO_SYSTEM_PAL) ? 16 : 13;
 179     displayPort->rows = displayRows + displayPortProfileMsp()->rowAdjust;
 180     displayPort->cols = 30 + displayPortProfileMsp()->colAdjust;
 181 #endif // USE_OSD
 182     drawScreen(displayPort);
 183 }
 184
 185 static uint32_t txBytesFree(const displayPort_t *displayPort)
 186 {
 187     UNUSED(displayPort);
 188     return mspSerialTxBytesFree();
 189 }
 190
 191 static const displayPortVTable_t mspDisplayPortVTable = {
 192     .grab = grab,
 193     .release = release,
 194     .clearScreen = clearScreen,
 195     .drawScreen = drawScreen,
 196     .screenSize = screenSize,
 197     .writeSys = writeSys,
 198     .writeString = writeString,
 199     .writeChar = writeChar,
 200     .isTransferInProgress = isTransferInProgress,
 201     .heartbeat = heartbeat,
 202     .redraw = redraw,
 203     .isSynced = isSynced,
 204     .txBytesFree = txBytesFree,
 205     .layerSupported = NULL,
 206     .layerSelect = NULL,
 207     .layerCopy = NULL,
 208 };
 209
 210 displayPort_t *displayPortMspInit(void)
 211 {
 212     displayInit(&mspDisplayPort, &mspDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_MSP);
 213
 214     if (displayPortProfileMsp()->useDeviceBlink) {
 215         mspDisplayPort.useDeviceBlink = true;
 216     }
 217
 218     redraw(&mspDisplayPort);
 219     return &mspDisplayPort;
 220 }
 221
 222 void displayPortMspSetSerial(serialPortIdentifier_e serialPort) {
 223     displayPortSerial = serialPort;
 224 }
 225 #endif // USE_MSP_DISPLAYPORT