src/main/io/displayport_max7456.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
  24 #include "platform.h"
  25
  26 #ifdef USE_MAX7456
  27
  28 #include "common/utils.h"
  29
  30 #include "drivers/display.h"
  31 #include "drivers/max7456.h"
  32 #include "drivers/osd.h"
  33
  34 #include "config/config.h"
  35
  36 #include "fc/runtime_config.h"
  37
  38 #include "io/displayport_max7456.h"
  39
  40 #include "osd/osd.h"
  41
  42 #include "pg/displayport_profiles.h"
  43 #include "pg/max7456.h"
  44 #include "pg/vcd.h"
  45
  46 static displayPort_t max7456DisplayPort;
  47 static vcdProfile_t const *max7456VcdProfile;
  48
  49 static int grab(displayPort_t *displayPort)
  50 {
  51     UNUSED(displayPort);
  52
  53     return 0;
  54 }
  55
  56 static int release(displayPort_t *displayPort)
  57 {
  58     UNUSED(displayPort);
  59
  60     return 0;
  61 }
  62
  63 static int clearScreen(displayPort_t *displayPort, displayClearOption_e options)
  64 {
  65     UNUSED(displayPort);
  66     UNUSED(options);
  67
  68     max7456Invert(displayPortProfileMax7456()->invert);
  69     max7456Brightness(displayPortProfileMax7456()->blackBrightness, displayPortProfileMax7456()->whiteBrightness);
  70
  71     max7456ClearScreen();
  72
  73     return 0;
  74 }
  75
  76 // Return true if screen still being transferred
  77 static bool drawScreen(displayPort_t *displayPort)
  78 {
  79     UNUSED(displayPort);
  80     return max7456DrawScreen();
  81 }
  82
  83 static int screenSize(const displayPort_t *displayPort)
  84 {
  85     UNUSED(displayPort);
  86     return maxScreenSize;
  87 }
  88
  89 static int writeString(displayPort_t *displayPort, uint8_t x, uint8_t y, uint8_t attr, const char *s)
  90 {
  91     UNUSED(displayPort);
  92     UNUSED(attr);
  93
  94     max7456Write(x, y, s);
  95
  96     return 0;
  97 }
  98
  99 static int writeChar(displayPort_t *displayPort, uint8_t x, uint8_t y, uint8_t attr, uint8_t c)
 100 {
 101     UNUSED(displayPort);
 102     UNUSED(attr);
 103
 104     max7456WriteChar(x, y, c);
 105
 106     return 0;
 107 }
 108
 109 static bool isTransferInProgress(const displayPort_t *displayPort)
 110 {
 111     UNUSED(displayPort);
 112     return max7456DmaInProgress();
 113 }
 114
 115 static bool isSynced(const displayPort_t *displayPort)
 116 {
 117     UNUSED(displayPort);
 118     return max7456BuffersSynced();
 119 }
 120
 121 static void redraw(displayPort_t *displayPort)
 122 {
 123     UNUSED(displayPort);
 124
 125     if (!ARMING_FLAG(ARMED)) {
 126         max7456RefreshAll();
 127     }
 128 }
 129
 130 static int heartbeat(displayPort_t *displayPort)
 131 {
 132     UNUSED(displayPort);
 133
 134     // (Re)Initialize MAX7456 at startup or stall is detected.
 135     return max7456ReInitIfRequired(false);
 136 }
 137
 138 static uint32_t txBytesFree(const displayPort_t *displayPort)
 139 {
 140     UNUSED(displayPort);
 141     return UINT32_MAX;
 142 }
 143
 144 static bool layerSupported(displayPort_t *displayPort, displayPortLayer_e layer)
 145 {
 146     UNUSED(displayPort);
 147     return max7456LayerSupported(layer);
 148 }
 149
 150 static bool layerSelect(displayPort_t *displayPort, displayPortLayer_e layer)
 151 {
 152     UNUSED(displayPort);
 153     return max7456LayerSelect(layer);
 154 }
 155
 156 static bool layerCopy(displayPort_t *displayPort, displayPortLayer_e destLayer, displayPortLayer_e sourceLayer)
 157 {
 158     UNUSED(displayPort);
 159     return max7456LayerCopy(destLayer, sourceLayer);
 160 }
 161
 162 static bool writeFontCharacter(displayPort_t *displayPort, uint16_t addr, const osdCharacter_t *chr)
 163 {
 164     UNUSED(displayPort);
 165
 166     return max7456WriteNvm(addr, (const uint8_t *)chr);
 167 }
 168
 169 static bool checkReady(displayPort_t *displayPort, bool rescan)
 170 {
 171     UNUSED(displayPort);
 172     if (!max7456IsDeviceDetected()) {
 173         if (!rescan) {
 174             return false;
 175         } else {
 176             // Try to initialize the device
 177             if (max7456Init(max7456Config(), max7456VcdProfile, systemConfig()->cpu_overclock) != MAX7456_INIT_OK) {
 178                 return false;
 179             }
 180             // At this point the device has been initialized and detected
 181             redraw(&max7456DisplayPort);
 182         }
 183     }
 184
 185     displayPort->rows = max7456GetRowsCount() + displayPortProfileMax7456()->rowAdjust;
 186     displayPort->cols = 30 + displayPortProfileMax7456()->colAdjust;
 187
 188     return true;
 189 }
 190
 191 void setBackgroundType(displayPort_t *displayPort, displayPortBackground_e backgroundType)
 192 {
 193     UNUSED(displayPort);
 194     max7456SetBackgroundType(backgroundType);
 195 }
 196
 197 static const displayPortVTable_t max7456VTable = {
 198     .grab = grab,
 199     .release = release,
 200     .clearScreen = clearScreen,
 201     .drawScreen = drawScreen,
 202     .screenSize = screenSize,
 203     .writeString = writeString,
 204     .writeChar = writeChar,
 205     .isTransferInProgress = isTransferInProgress,
 206     .heartbeat = heartbeat,
 207     .redraw = redraw,
 208     .isSynced = isSynced,
 209     .txBytesFree = txBytesFree,
 210     .layerSupported = layerSupported,
 211     .layerSelect = layerSelect,
 212     .layerCopy = layerCopy,
 213     .writeFontCharacter = writeFontCharacter,
 214     .checkReady = checkReady,
 215     .setBackgroundType = setBackgroundType,
 216 };
 217
 218 bool max7456DisplayPortInit(const vcdProfile_t *vcdProfile, displayPort_t **displayPort)
 219 {
 220     max7456VcdProfile = vcdProfile;
 221
 222     switch (max7456Init(max7456Config(), max7456VcdProfile, systemConfig()->cpu_overclock)) {
 223     case MAX7456_INIT_NOT_CONFIGURED:
 224         // MAX7456 IO pins are not defined. We either don't have
 225         // it on board or either the configuration for it has
 226         // not been set.
 227         *displayPort = NULL;
 228
 229         return false;
 230
 231         break;
 232     case MAX7456_INIT_NOT_FOUND:
 233         // MAX7456 IO pins are defined, but we could not get a reply
 234         // from it at this time. Delay full initialization to
 235         // checkReady() with 'rescan' enabled
 236         displayInit(&max7456DisplayPort, &max7456VTable, DISPLAYPORT_DEVICE_TYPE_MAX7456);
 237         *displayPort = &max7456DisplayPort;
 238
 239         return false;
 240
 241         break;
 242     case MAX7456_INIT_OK:
 243         // MAX7456 configured and detected
 244         displayInit(&max7456DisplayPort, &max7456VTable, DISPLAYPORT_DEVICE_TYPE_MAX7456);
 245         *displayPort = &max7456DisplayPort;
 246
 247         break;
 248     }
 249
 250     return true;
 251 }
 252 #endif // USE_MAX7456