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 "pg/vcd.h"
  44
  45 static displayPort_t mspDisplayPort;
  46
  47 static int output(displayPort_t *displayPort, uint8_t cmd, uint8_t *buf, int len)
  48 {
  49     UNUSED(displayPort);
  50
  51 #ifdef USE_CLI
  52     // 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.
  53     if (cliMode) {
  54         return 0;
  55     }
  56 #endif
  57     return mspSerialPush(displayPortProfileMsp()->displayPortSerial, cmd, buf, len, MSP_DIRECTION_REPLY);
  58 }
  59
  60 static int heartbeat(displayPort_t *displayPort)
  61 {
  62     uint8_t subcmd[] = { 0 };
  63
  64     // heartbeat is used to:
  65     // a) ensure display is not released by MW OSD software
  66     // b) prevent OSD Slave boards from displaying a 'disconnected' status.
  67     output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  68
  69     return 0;
  70 }
  71
  72 static int grab(displayPort_t *displayPort)
  73 {
  74     return heartbeat(displayPort);
  75 }
  76
  77 static int release(displayPort_t *displayPort)
  78 {
  79     uint8_t subcmd[] = { 1 };
  80
  81     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  82 }
  83
  84 static int clearScreen(displayPort_t *displayPort, displayClearOption_e options)
  85 {
  86     UNUSED(options);
  87
  88     uint8_t subcmd[] = { 2 };
  89
  90     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  91 }
  92
  93 static bool drawScreen(displayPort_t *displayPort)
  94 {
  95     uint8_t subcmd[] = { 4 };
  96     output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  97
  98     return 0;
  99 }
 100
 101 static int screenSize(const displayPort_t *displayPort)
 102 {
 103     return displayPort->rows * displayPort->cols;
 104 }
 105
 106 static int writeString(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, const char *string)
 107 {
 108 #define MSP_OSD_MAX_STRING_LENGTH 30 // FIXME move this
 109     uint8_t buf[MSP_OSD_MAX_STRING_LENGTH + 4];
 110
 111     int len = strlen(string);
 112     if (len >= MSP_OSD_MAX_STRING_LENGTH) {
 113         len = MSP_OSD_MAX_STRING_LENGTH;
 114     }
 115
 116     buf[0] = 3;
 117     buf[1] = row;
 118     buf[2] = col;
 119     buf[3] = displayPortProfileMsp()->attrValues[attr] & ~DISPLAYPORT_MSP_ATTR_BLINK & DISPLAYPORT_MSP_ATTR_MASK;
 120
 121     if (attr & DISPLAYPORT_ATTR_BLINK) {
 122         buf[3] |= DISPLAYPORT_MSP_ATTR_BLINK;
 123     }
 124
 125     memcpy(&buf[4], string, len);
 126
 127     return output(displayPort, MSP_DISPLAYPORT, buf, len + 4);
 128 }
 129
 130 static int writeChar(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, uint8_t c)
 131 {
 132     char buf[2];
 133
 134     buf[0] = c;
 135     buf[1] = 0;
 136     return writeString(displayPort, col, row, attr, buf); //!!TODO - check if there is a direct MSP command to do this
 137 }
 138
 139 static bool isTransferInProgress(const displayPort_t *displayPort)
 140 {
 141     UNUSED(displayPort);
 142     return false;
 143 }
 144
 145 static bool isSynced(const displayPort_t *displayPort)
 146 {
 147     UNUSED(displayPort);
 148     return true;
 149 }
 150
 151 static void redraw(displayPort_t *displayPort)
 152 {
 153     const uint8_t displayRows = (vcdProfile()->video_system == VIDEO_SYSTEM_PAL) ? 16 : 13;
 154     displayPort->rows = displayRows + displayPortProfileMsp()->rowAdjust;
 155     displayPort->cols = 30 + displayPortProfileMsp()->colAdjust;
 156     drawScreen(displayPort);
 157 }
 158
 159 static uint32_t txBytesFree(const displayPort_t *displayPort)
 160 {
 161     UNUSED(displayPort);
 162     return mspSerialTxBytesFree();
 163 }
 164
 165 static const displayPortVTable_t mspDisplayPortVTable = {
 166     .grab = grab,
 167     .release = release,
 168     .clearScreen = clearScreen,
 169     .drawScreen = drawScreen,
 170     .screenSize = screenSize,
 171     .writeString = writeString,
 172     .writeChar = writeChar,
 173     .isTransferInProgress = isTransferInProgress,
 174     .heartbeat = heartbeat,
 175     .redraw = redraw,
 176     .isSynced = isSynced,
 177     .txBytesFree = txBytesFree,
 178     .layerSupported = NULL,
 179     .layerSelect = NULL,
 180     .layerCopy = NULL,
 181 };
 182
 183 displayPort_t *displayPortMspInit(void)
 184 {
 185     displayInit(&mspDisplayPort, &mspDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_MSP);
 186
 187     if (displayPortProfileMsp()->useDeviceBlink) {
 188         mspDisplayPort.useDeviceBlink = true;
 189     }
 190
 191     redraw(&mspDisplayPort);
 192     return &mspDisplayPort;
 193 }
 194 #endif // USE_MSP_DISPLAYPORT