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