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     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  68 }
  69
  70 static int grab(displayPort_t *displayPort)
  71 {
  72     return heartbeat(displayPort);
  73 }
  74
  75 static int release(displayPort_t *displayPort)
  76 {
  77     uint8_t subcmd[] = { 1 };
  78
  79     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  80 }
  81
  82 static int clearScreen(displayPort_t *displayPort)
  83 {
  84     uint8_t subcmd[] = { 2 };
  85
  86     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  87 }
  88
  89 static int drawScreen(displayPort_t *displayPort)
  90 {
  91     uint8_t subcmd[] = { 4 };
  92     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  93 }
  94
  95 static int screenSize(const displayPort_t *displayPort)
  96 {
  97     return displayPort->rows * displayPort->cols;
  98 }
  99
 100 static int writeString(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, const char *string)
 101 {
 102 #define MSP_OSD_MAX_STRING_LENGTH 30 // FIXME move this
 103     uint8_t buf[MSP_OSD_MAX_STRING_LENGTH + 4];
 104
 105     int len = strlen(string);
 106     if (len >= MSP_OSD_MAX_STRING_LENGTH) {
 107         len = MSP_OSD_MAX_STRING_LENGTH;
 108     }
 109
 110     buf[0] = 3;
 111     buf[1] = row;
 112     buf[2] = col;
 113     buf[3] = displayPortProfileMsp()->attrValues[attr] & ~DISPLAYPORT_MSP_ATTR_BLINK & DISPLAYPORT_MSP_ATTR_MASK;
 114
 115     if (attr & DISPLAYPORT_ATTR_BLINK) {
 116         buf[3] |= DISPLAYPORT_MSP_ATTR_BLINK;
 117     }
 118
 119     memcpy(&buf[4], string, len);
 120
 121     return output(displayPort, MSP_DISPLAYPORT, buf, len + 4);
 122 }
 123
 124 static int writeChar(displayPort_t *displayPort, uint8_t col, uint8_t row, uint8_t attr, uint8_t c)
 125 {
 126     char buf[2];
 127
 128     buf[0] = c;
 129     buf[1] = 0;
 130     return writeString(displayPort, col, row, attr, buf); //!!TODO - check if there is a direct MSP command to do this
 131 }
 132
 133 static bool isTransferInProgress(const displayPort_t *displayPort)
 134 {
 135     UNUSED(displayPort);
 136     return false;
 137 }
 138
 139 static bool isSynced(const displayPort_t *displayPort)
 140 {
 141     UNUSED(displayPort);
 142     return true;
 143 }
 144
 145 static void redraw(displayPort_t *displayPort)
 146 {
 147     const uint8_t displayRows = (vcdProfile()->video_system == VIDEO_SYSTEM_PAL) ? 16 : 13;
 148     displayPort->rows = displayRows + displayPortProfileMsp()->rowAdjust;
 149     displayPort->cols = 30 + displayPortProfileMsp()->colAdjust;
 150     drawScreen(displayPort);
 151 }
 152
 153 static uint32_t txBytesFree(const displayPort_t *displayPort)
 154 {
 155     UNUSED(displayPort);
 156     return mspSerialTxBytesFree();
 157 }
 158
 159 static const displayPortVTable_t mspDisplayPortVTable = {
 160     .grab = grab,
 161     .release = release,
 162     .clearScreen = clearScreen,
 163     .drawScreen = drawScreen,
 164     .screenSize = screenSize,
 165     .writeString = writeString,
 166     .writeChar = writeChar,
 167     .isTransferInProgress = isTransferInProgress,
 168     .heartbeat = heartbeat,
 169     .redraw = redraw,
 170     .isSynced = isSynced,
 171     .txBytesFree = txBytesFree,
 172     .layerSupported = NULL,
 173     .layerSelect = NULL,
 174     .layerCopy = NULL,
 175 };
 176
 177 displayPort_t *displayPortMspInit(void)
 178 {
 179     displayInit(&mspDisplayPort, &mspDisplayPortVTable, DISPLAYPORT_DEVICE_TYPE_MSP);
 180
 181     if (displayPortProfileMsp()->useDeviceBlink) {
 182         mspDisplayPort.useDeviceBlink = true;
 183     }
 184
 185     redraw(&mspDisplayPort);
 186     return &mspDisplayPort;
 187 }
 188 #endif // USE_MSP_DISPLAYPORT