src/main/drivers/vtx_common.h

   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 /* Created by jflyper */
  19
  20 #include "common/time.h"
  21
  22 #define VTX_SETTINGS_MIN_BAND       1
  23 #define VTX_SETTINGS_MAX_BAND       5
  24 #define VTX_SETTINGS_MIN_CHANNEL    1
  25 #define VTX_SETTINGS_MAX_CHANNEL    8
  26
  27 #define VTX_SETTINGS_BAND_COUNT     (VTX_SETTINGS_MAX_BAND - VTX_SETTINGS_MIN_BAND + 1)
  28 #define VTX_SETTINGS_CHANNEL_COUNT  (VTX_SETTINGS_MAX_CHANNEL - VTX_SETTINGS_MIN_CHANNEL + 1)
  29
  30 #define VTX_SETTINGS_DEFAULT_BAND               4
  31 #define VTX_SETTINGS_DEFAULT_CHANNEL            1
  32 #define VTX_SETTINGS_DEFAULT_PITMODE_CHANNEL    1
  33 #define VTX_SETTINGS_DEFAULT_LOW_POWER_DISARM   0
  34
  35 #if defined(USE_VTX_SMARTAUDIO) || defined(USE_VTX_TRAMP) || defined(USE_VTX_MSP)
  36
  37 #define VTX_SETTINGS_POWER_COUNT        8
  38 #define VTX_SETTINGS_DEFAULT_POWER      1
  39 #define VTX_SETTINGS_MIN_POWER          1
  40 #define VTX_SETTINGS_MIN_USER_FREQ      5000
  41 #define VTX_SETTINGS_MAX_USER_FREQ      5999
  42 #define VTX_SETTINGS_FREQCMD
  43 #define VTX_SETTINGS_MAX_POWER          (VTX_SETTINGS_POWER_COUNT - VTX_SETTINGS_MIN_POWER + 1)
  44
  45 #else
  46
  47 #define VTX_SETTINGS_DEFAULT_POWER      0
  48
  49 #endif
  50
  51 // check value for MSP_SET_VTX_CONFIG to determine if value is encoded
  52 // band/channel or frequency in MHz (3 bits for band and 3 bits for channel)
  53 #define VTXCOMMON_MSP_BANDCHAN_CHKVAL ((uint16_t)((7 << 3) + 7))
  54
  55 typedef enum {
  56     VTXDEV_UNSUPPORTED = 0, // reserved for MSP
  57     VTXDEV_RTC6705    = 1,  // deprecated
  58     // 2 reserved
  59     VTXDEV_SMARTAUDIO = 3,
  60     VTXDEV_TRAMP      = 4,
  61     VTXDEV_FFPV       = 5,
  62     VTXDEV_MSP        = 6,
  63     VTXDEV_UNKNOWN    = 0xFF,
  64 } vtxDevType_e;
  65
  66 typedef enum {
  67     FREQUENCYGROUP_5G8 = 0,
  68     FREQUENCYGROUP_2G4 = 1,
  69     FREQUENCYGROUP_1G3 = 2,
  70 } vtxFrequencyGroups_e;
  71
  72 struct vtxVTable_s;
  73
  74 typedef struct vtxDeviceCapability_s {
  75     uint8_t bandCount;
  76     uint8_t channelCount;
  77     uint8_t powerCount;
  78     char **bandNames;
  79     char **channelNames;
  80     char **powerNames;
  81 } vtxDeviceCapability_t;
  82
  83 typedef struct vtxDeviceOsdInfo_s {
  84     int band;
  85     int channel;
  86     int frequency;
  87     int powerIndex;
  88     int powerMilliwatt;
  89     char bandLetter;
  90     const char * bandName;
  91     const char * channelName;
  92     char powerIndexLetter;
  93 } vtxDeviceOsdInfo_t;
  94
  95 typedef struct vtxDevice_s {
  96     const struct vtxVTable_s * const vTable;
  97
  98     vtxDeviceCapability_t capability;
  99
 100     uint8_t band; // Band = 1, 1-based
 101     uint8_t channel; // CH1 = 1, 1-based
 102     uint8_t powerIndex; // Lowest/Off = 0
 103     uint8_t pitMode; // 0 = non-PIT, 1 = PIT
 104 } vtxDevice_t;
 105
 106 // {set,get}BandAndChannel: band and channel are 1 origin
 107 // {set,get}PowerByIndex: 0 = Power OFF, 1 = device dependent
 108 // {set,get}PitMode: 0 = OFF, 1 = ON
 109
 110 typedef struct vtxVTable_s {
 111     void (*process)(vtxDevice_t *vtxDevice, timeUs_t currentTimeUs);
 112     vtxDevType_e (*getDeviceType)(const vtxDevice_t *vtxDevice);
 113     bool (*isReady)(const vtxDevice_t *vtxDevice);
 114
 115     void (*setBandAndChannel)(vtxDevice_t *vtxDevice, uint8_t band, uint8_t channel);
 116     void (*setPowerByIndex)(vtxDevice_t *vtxDevice, uint8_t level);
 117     void (*setPitMode)(vtxDevice_t *vtxDevice, uint8_t onoff);
 118
 119     bool (*getBandAndChannel)(const vtxDevice_t *vtxDevice, uint8_t *pBand, uint8_t *pChannel);
 120     bool (*getPowerIndex)(const vtxDevice_t *vtxDevice, uint8_t *pIndex);
 121     bool (*getPitMode)(const vtxDevice_t *vtxDevice, uint8_t *pOnOff);
 122     bool (*getFrequency)(const vtxDevice_t *vtxDevice, uint16_t *pFreq);
 123
 124     bool (*getPower)(const vtxDevice_t *vtxDevice, uint8_t *pIndex, uint16_t *pPowerMw);
 125     bool (*getOsdInfo)(const  vtxDevice_t *vtxDevice, vtxDeviceOsdInfo_t * pOsdInfo);
 126 } vtxVTable_t;
 127
 128 // 3.1.0
 129 // PIT mode is defined as LOWEST POSSIBLE RF POWER.
 130 // - It can be a dedicated mode, or lowest RF power possible.
 131 // - It is *NOT* RF on/off control ?
 132
 133 void vtxCommonInit(void);
 134 void vtxCommonSetDevice(vtxDevice_t *vtxDevice);
 135 vtxDevice_t *vtxCommonDevice(void);
 136
 137 // VTable functions
 138 void vtxCommonProcess(vtxDevice_t *vtxDevice, timeUs_t currentTimeUs);
 139 vtxDevType_e vtxCommonGetDeviceType(vtxDevice_t *vtxDevice);
 140 bool vtxCommonDeviceIsReady(vtxDevice_t *vtxDevice);
 141 void vtxCommonSetBandAndChannel(vtxDevice_t *vtxDevice, uint8_t band, uint8_t channel);
 142 void vtxCommonSetPowerByIndex(vtxDevice_t *vtxDevice, uint8_t index);
 143 void vtxCommonSetPitMode(vtxDevice_t *vtxDevice, uint8_t onoff);
 144 bool vtxCommonGetBandAndChannel(vtxDevice_t *vtxDevice, uint8_t *pBand, uint8_t *pChannel);
 145 bool vtxCommonGetPowerIndex(vtxDevice_t *vtxDevice, uint8_t *pIndex);
 146 bool vtxCommonGetPitMode(vtxDevice_t *vtxDevice, uint8_t *pOnOff);
 147 bool vtxCommonGetFrequency(const vtxDevice_t *vtxDevice, uint16_t *pFreq);
 148 bool vtxCommonGetDeviceCapability(vtxDevice_t *vtxDevice, vtxDeviceCapability_t *pDeviceCapability);
 149 bool vtxCommonGetPower(const vtxDevice_t *vtxDevice, uint8_t *pIndex, uint16_t *pPowerMw);
 150 bool vtxCommonGetOsdInfo(vtxDevice_t *vtxDevice, vtxDeviceOsdInfo_t * pOsdInfo);