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     return mspSerialPush(displayPortSerial, cmd, buf, len, MSP_DIRECTION_REPLY, MSP_V1);
  55 }
  56
  57 static int heartbeat(displayPort_t *displayPort)
  58 {
  59     uint8_t subcmd[] = { MSP_DP_HEARTBEAT };
  60
  61     // heartbeat is used to:
  62     // a) ensure display is not released by MW OSD software
  63     // b) prevent OSD Slave boards from displaying a 'disconnected' status.
  64     output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  65
  66     return 0;
  67 }
  68
  69 static int grab(displayPort_t *displayPort)
  70 {
  71     return heartbeat(displayPort);
  72 }
  73
  74 static int release(displayPort_t *displayPort)
  75 {
  76     uint8_t subcmd[] = { MSP_DP_RELEASE };
  77
  78     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  79 }
  80
  81 static int clearScreen(displayPort_t *displayPort, displayClearOption_e options)
  82 {
  83     UNUSED(options);
  84
  85     uint8_t subcmd[] = { MSP_DP_CLEAR_SCREEN };
  86
  87     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  88 }
  89
  90 static bool drawScreen(displayPort_t *displayPort)
  91 {
  92     uint8_t subcmd[] = { MSP_DP_DRAW_SCREEN };
  93     output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  94
  95     return 0;
  96 }
  97
  98 static int screenSize(const displayPort_t *displayPort)
  99 {
 100     return displayPort->rows * displayPort->cols;
 101 }
 102
 103 static int writeString(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, const char *string)
 104 {
 105 #define MSP_OSD_MAX_STRING_LENGTH 30 // FIXME move this
 106     uint8_t buf[MSP_OSD_MAX_STRING_LENGTH + 4];
 107
 108     int len = strlen(string);
 109     if (len >= MSP_OSD_MAX_STRING_LENGTH) {
 110         len = MSP_OSD_MAX_STRING_LENGTH;
 111     }
 112
 113     buf[0] = MSP_DP_WRITE_STRING;
 114     buf[1] = row;
 115     buf[2] = col;
 116     buf[3] = displayPortProfileMsp()->fontSelection[attr & (DISPLAYPORT_SEVERITY_COUNT - 1)] & DISPLAYPORT_MSP_ATTR_FONT;
 117
 118     if (attr & DISPLAYPORT_BLINK) {
 119         buf[3] |= DISPLAYPORT_MSP_ATTR_BLINK;
 120     }
 121
 122     memcpy(&buf[4], string, len);
 123
 124     return output(displayPort, MSP_DISPLAYPORT, buf, len + 4);
 125 }
 126
 127 static int writeSys(displayPort_t *displayPort, uint8_t col, uint8_t row, displayPortSystemElement_e systemElement)
 128 {
 129     uint8_t syscmd[4];
 130
 131     syscmd[0] = MSP_DP_SYS;
 132     syscmd[1] = row;
 133     syscmd[2] = col;
 134     syscmd[3] = systemElement;
 135
 136     return output(displayPort, MSP_DISPLAYPORT, syscmd, sizeof(syscmd));
 137 }
 138
 139 static int writeChar(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, uint8_t c)
 140 {
 141     char buf[2];
 142
 143     buf[0] = c;
 144     buf[1] = 0;
 145     return writeString(displayPort, col, row, attr, buf);
 146 }
 147
 148 static bool isTransferInProgress(const displayPort_t *displayPort)
 149 {
 150     UNUSED(displayPort);
 151     return false;
 152 }
 153
 154 static bool isSynced(const displayPort_t *displayPort)
 155 {
 156     UNUSED(displayPort);
 157     return true;
 158 }
 159
 160 static void redraw(displayPort_t *displayPort)
 161 {
 162     drawScreen(displayPort);
 163 }
 164
 165 static uint32_t txBytesFree(const displayPort_t *displayPort)
 166 {
 167     UNUSED(displayPort);
 168     return mspSerialTxBytesFree();
 169 }
 170
 171 static const displayPortVTable_t mspDisplayPortVTable = {
 172     .grab = grab,
 173     .release = release,
 174     .clearScreen = clearScreen,
 175     .drawScreen = drawScreen,
 176     .screenSize = screenSize,
 177     .writeSys = writeSys,
 178     .writeString = writeString,
 179     .writeChar = writeChar,
 180     .isTransferInProgress = isTransferInProgress,
 181     .heartbeat = heartbeat,
 182     .redraw = redraw,
 183     .isSynced = isSynced,
 184     .txBytesFree = txBytesFree,
 185     .layerSupported = NULL,
 186     .layerSelect = NULL,
 187     .layerCopy = NULL,
 188 };
 189
 190 displayPort_t *displayPortMspInit(void)
 191 {
 192     displayInit(&mspDisplayPort, &mspDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_MSP);
 193
 194     if (displayPortProfileMsp()->useDeviceBlink) {
 195         mspDisplayPort.useDeviceBlink = true;
 196     }
 197
 198 #ifndef USE_OSD_SD
 199     if (vcdProfile()->video_system != VIDEO_SYSTEM_HD) {
 200         vcdProfileMutable()->video_system = VIDEO_SYSTEM_HD;
 201     }
 202 #endif
 203 #ifndef USE_OSD_HD
 204     if (vcdProfile()->video_system == VIDEO_SYSTEM_HD) {
 205         vcdProfileMutable()->video_system = VIDEO_SYSTEM_AUTO;
 206     }
 207 #endif
 208
 209     if (vcdProfile()->video_system == VIDEO_SYSTEM_HD) {
 210         mspDisplayPort.rows = osdConfig()->canvas_rows;
 211         mspDisplayPort.cols = osdConfig()->canvas_cols;
 212     } else {
 213         const uint8_t displayRows = (vcdProfile()->video_system == VIDEO_SYSTEM_PAL) ? VIDEO_LINES_PAL : VIDEO_LINES_NTSC;
 214         mspDisplayPort.rows = displayRows + displayPortProfileMsp()->rowAdjust;
 215         mspDisplayPort.cols = OSD_SD_COLS + displayPortProfileMsp()->colAdjust;
 216     }
 217
 218     redraw(&mspDisplayPort);
 219
 220     return &mspDisplayPort;
 221 }
 222
 223 void displayPortMspSetSerial(serialPortIdentifier_e serialPort)
 224 {
 225     displayPortSerial = serialPort;
 226 }
 227
 228 serialPortIdentifier_e displayPortMspGetSerial(void) {
 229     return displayPortSerial;
 230 }
 231 #endif // USE_MSP_DISPLAYPORT