src/main/io/displayport_msp.c

   1 /*
   2  * This file is part of Cleanflight.
   3  *
   4  * Cleanflight is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * Cleanflight is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with Cleanflight.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 #include <stdbool.h>
  19 #include <stdint.h>
  20 #include <string.h>
  21 #include <ctype.h>
  22
  23 #include "platform.h"
  24
  25 #ifdef USE_MSP_DISPLAYPORT
  26
  27 #include "common/utils.h"
  28
  29 #include "config/parameter_group.h"
  30 #include "config/parameter_group_ids.h"
  31
  32 #include "drivers/display.h"
  33
  34 #include "fc/fc_msp.h"
  35
  36 #include "io/displayport_msp.h"
  37
  38 #include "msp/msp_protocol.h"
  39 #include "msp/msp_serial.h"
  40
  41 #define MSP_OSD_MAX_STRING_LENGTH 30
  42
  43 static displayPort_t mspDisplayPort;
  44
  45 extern uint8_t cliMode;
  46
  47 static int output(displayPort_t *displayPort, uint8_t cmd, uint8_t *buf, int len)
  48 {
  49     UNUSED(displayPort);
  50
  51     // 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.
  52     if (cliMode) {
  53         return 0;
  54     }
  55     return mspSerialPush(cmd, buf, len);
  56 }
  57
  58 static int heartbeat(displayPort_t *displayPort)
  59 {
  60     uint8_t subcmd[] = { 0 };
  61
  62     // heartbeat is used to:
  63     // a) ensure display is not released by MW OSD software
  64     // b) prevent OSD Slave boards from displaying a 'disconnected' status.
  65     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  66 }
  67
  68 static int grab(displayPort_t *displayPort)
  69 {
  70     return heartbeat(displayPort);
  71 }
  72
  73 static int release(displayPort_t *displayPort)
  74 {
  75     uint8_t subcmd[] = { MSP_DP_RELEASE };
  76
  77     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  78 }
  79
  80 static int clearScreen(displayPort_t *displayPort)
  81 {
  82     uint8_t subcmd[] = { MSP_DP_CLEAR_SCREEN };
  83
  84     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  85 }
  86
  87 static int drawScreen(displayPort_t *displayPort)
  88 {
  89     uint8_t subcmd[] = { MSP_DP_DRAW_SCREEN };
  90     return output(displayPort, MSP_DISPLAYPORT, subcmd, sizeof(subcmd));
  91 }
  92
  93 static int screenSize(const displayPort_t *displayPort)
  94 {
  95     return displayPort->rows * displayPort->cols;
  96 }
  97
  98 static int writeString(displayPort_t *displayPort, uint8_t col, uint8_t row, const char *string, textAttributes_t attr)
  99 {
 100     UNUSED(attr);
 101
 102     uint8_t buf[MSP_OSD_MAX_STRING_LENGTH + 4];
 103
 104     int len = strlen(string);
 105     if (len >= MSP_OSD_MAX_STRING_LENGTH) {
 106         len = MSP_OSD_MAX_STRING_LENGTH;
 107     }
 108
 109     buf[0] = MSP_DP_WRITE_STRING;
 110     buf[1] = row;
 111     buf[2] = col;
 112     buf[3] = 0;
 113     memcpy(&buf[4], string, len);
 114
 115     return output(displayPort, MSP_DISPLAYPORT, buf, len + 4);
 116 }
 117
 118 static int writeChar(displayPort_t *displayPort, uint8_t col, uint8_t row, uint16_t c, textAttributes_t attr)
 119 {
 120     char buf[2];
 121
 122     buf[0] = c;
 123     buf[1] = 0;
 124     return writeString(displayPort, col, row, buf, attr); //!!TODO - check if there is a direct MSP command to do this
 125 }
 126
 127 static bool isTransferInProgress(const displayPort_t *displayPort)
 128 {
 129     UNUSED(displayPort);
 130     return false;
 131 }
 132
 133 static void resync(displayPort_t *displayPort)
 134 {
 135     displayPort->rows = 13;
 136     displayPort->cols = 30;
 137 }
 138
 139 static uint32_t txBytesFree(const displayPort_t *displayPort)
 140 {
 141     UNUSED(displayPort);
 142     return mspSerialTxBytesFree();
 143 }
 144
 145 static const displayPortVTable_t mspDisplayPortVTable = {
 146     .grab = grab,
 147     .release = release,
 148     .clearScreen = clearScreen,
 149     .drawScreen = drawScreen,
 150     .screenSize = screenSize,
 151     .writeString = writeString,
 152     .writeChar = writeChar,
 153     .readChar = NULL,
 154     .isTransferInProgress = isTransferInProgress,
 155     .heartbeat = heartbeat,
 156     .resync = resync,
 157     .txBytesFree = txBytesFree,
 158     .supportedTextAttributes = NULL,
 159 };
 160
 161 displayPort_t *displayPortMspInit(void)
 162 {
 163     displayInit(&mspDisplayPort, &mspDisplayPortVTable);
 164     resync(&mspDisplayPort);
 165     mspDisplayPort.displayPortType = "MSP";
 166     return &mspDisplayPort;
 167 }
 168
 169 #endif // USE_MSP_DISPLAYPORT