companion/src/firmwares/opentx/opentxinterface.h

   1 /*
   2  * Copyright (C) OpenTX
   3  *
   4  * Based on code named
   5  *   th9x - http://code.google.com/p/th9x
   6  *   er9x - http://code.google.com/p/er9x
   7  *   gruvin9x - http://code.google.com/p/gruvin9x
   8  *
   9  * License GPLv2: http://www.gnu.org/licenses/gpl-2.0.html
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License version 2 as
  13  * published by the Free Software Foundation.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  */
  20
  21 #ifndef _OPENTXINTERFACE_H_
  22 #define _OPENTXINTERFACE_H_
  23
  24 #include "eeprominterface.h"
  25
  26 class RleFile;
  27 class OpenTxFirmware;
  28
  29 class OpenTxEepromInterface : public EEPROMInterface
  30 {
  31   public:
  32
  33     OpenTxEepromInterface(OpenTxFirmware * firmware);
  34
  35     virtual ~OpenTxEepromInterface();
  36
  37     virtual unsigned long load(RadioData &, const uint8_t * eeprom, int size);
  38
  39     bool loadModelFromBackup(ModelData & model, const uint8_t * data, unsigned int size, uint8_t version, uint32_t variant);
  40
  41     virtual unsigned long loadBackup(RadioData &, const uint8_t * eeprom, int esize, int index);
  42
  43     virtual int save(uint8_t * eeprom, const RadioData & radioData, uint8_t version=0, uint32_t variant=0);
  44
  45     virtual int getSize(const ModelData &);
  46
  47     virtual int getSize(const GeneralSettings &);
  48
  49   protected:
  50
  51     const char * getName();
  52
  53     EepromLoadErrors checkVersion(unsigned int version);
  54
  55     bool checkVariant(unsigned int version, unsigned int variant);
  56
  57     template <class T, class M>
  58     bool loadFromByteArray(T & dest, const QByteArray & data, uint8_t version, uint32_t variant=0);
  59
  60   public:
  61     template <class T, class M>
  62     bool loadFromByteArray(T & dest, const QByteArray & data);
  63
  64     template <class T, class M>
  65     bool saveToByteArray(const T & src, QByteArray & data, uint8_t version=0);
  66
  67     bool loadRadioSettingsFromRLE(GeneralSettings & settings, RleFile * rleFile, uint8_t version);
  68
  69     bool loadModelFromRLE(ModelData & model, RleFile * rleFile, unsigned int index, uint8_t version, uint32_t variant);
  70
  71     template <class T>
  72     bool saveModel(unsigned int index, ModelData & model, uint8_t version, uint32_t variant);
  73
  74     template <class T>
  75     bool saveRadioSettings(GeneralSettings & settings, BoardEnum board, uint8_t version, uint32_t variant);
  76
  77     uint8_t getLastDataVersion(BoardEnum board);
  78
  79     uint32_t getFourCC();
  80
  81     RleFile * efile;
  82
  83     OpenTxFirmware * firmware;
  84
  85 };
  86
  87 class OpenTxFirmware: public Firmware
  88 {
  89   public:
  90     OpenTxFirmware(const QString & id, OpenTxFirmware * parent):
  91       Firmware(parent, id, parent->getName(), parent->getBoard())
  92     {
  93       setEEpromInterface(parent->getEEpromInterface());
  94     }
  95
  96     OpenTxFirmware(const QString & id, const QString & name, const BoardEnum board):
  97       Firmware(id, name, board)
  98     {
  99       addLanguage("en");
 100       addLanguage("cz");
 101       addLanguage("de");
 102       addLanguage("es");
 103       addLanguage("fr");
 104       addLanguage("it");
 105       addLanguage("nl");
 106       addLanguage("pl");
 107       addLanguage("pt");
 108       addLanguage("se");
 109
 110       addTTSLanguage("en");
 111       addTTSLanguage("cz");
 112       addTTSLanguage("de");
 113       addTTSLanguage("es");
 114       addTTSLanguage("fr");
 115       addTTSLanguage("hu");
 116       addTTSLanguage("it");
 117       addTTSLanguage("nl");
 118       addTTSLanguage("pl");
 119       addTTSLanguage("pt");
 120       addTTSLanguage("se");
 121       addTTSLanguage("sk");
 122     }
 123
 124     virtual Firmware * getFirmwareVariant(const QString & id);
 125
 126     virtual QString getStampUrl();
 127
 128     virtual QString getReleaseNotesUrl();
 129
 130     virtual QString getFirmwareUrl();
 131
 132     virtual int getCapability(Capability);
 133
 134     virtual QString getAnalogInputName(unsigned int index);
 135
 136     virtual QTime getMaxTimerStart();
 137
 138     virtual int isAvailable(PulsesProtocol proto, int port=0);
 139
 140   protected:
 141
 142     QString getFirmwareBaseUrl();
 143
 144 };
 145
 146 void registerOpenTxFirmwares();
 147 void unregisterOpenTxFirmwares();
 148
 149 extern QList<OpenTxEepromInterface *> opentxEEpromInterfaces;
 150
 151 OpenTxEepromInterface * loadModelFromByteArray(ModelData & model, const QByteArray & data);
 152 OpenTxEepromInterface * loadRadioSettingsFromByteArray(GeneralSettings & settings, const QByteArray & data);
 153
 154 bool writeModelToByteArray(const ModelData & model, QByteArray & data);
 155 bool writeRadioSettingsToByteArray(const GeneralSettings & settings, QByteArray & data);
 156
 157 #endif // _OPENTXINTERFACE_H_