src/main/drivers/vtx_common.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 /* Created by jflyper */
  19
  20 #include <stdbool.h>
  21 #include <stdint.h>
  22 #include <ctype.h>
  23 #include <string.h>
  24
  25 #include "platform.h"
  26 #include "build/debug.h"
  27
  28 #include "vtx_common.h"
  29
  30 static vtxDevice_t *commonVtxDevice = NULL;
  31
  32 void vtxCommonInit(void)
  33 {
  34 }
  35
  36 void vtxCommonSetDevice(vtxDevice_t *vtxDevice)
  37 {
  38     commonVtxDevice = vtxDevice;
  39 }
  40
  41 vtxDevice_t *vtxCommonDevice(void)
  42 {
  43     return commonVtxDevice;
  44 }
  45
  46 void vtxCommonProcess(vtxDevice_t *vtxDevice, timeUs_t currentTimeUs)
  47 {
  48     if (vtxDevice && vtxDevice->vTable->process) {
  49         vtxDevice->vTable->process(vtxDevice, currentTimeUs);
  50     }
  51 }
  52
  53 vtxDevType_e vtxCommonGetDeviceType(vtxDevice_t *vtxDevice)
  54 {
  55     if (!vtxDevice || !vtxDevice->vTable->getDeviceType) {
  56         return VTXDEV_UNKNOWN;
  57     }
  58
  59     return vtxDevice->vTable->getDeviceType(vtxDevice);
  60 }
  61
  62 bool vtxCommonDeviceIsReady(vtxDevice_t *vtxDevice)
  63 {
  64     if (vtxDevice && vtxDevice->vTable->isReady) {
  65         return vtxDevice->vTable->isReady(vtxDevice);
  66     }
  67     return false;
  68 }
  69
  70 // band and channel are 1 origin
  71 void vtxCommonSetBandAndChannel(vtxDevice_t *vtxDevice, uint8_t band, uint8_t channel)
  72 {
  73     if (!vtxDevice)
  74         return;
  75
  76     if ((band > vtxDevice->capability.bandCount) || (channel > vtxDevice->capability.channelCount))
  77         return;
  78
  79     if (vtxDevice->vTable->setBandAndChannel) {
  80         vtxDevice->vTable->setBandAndChannel(vtxDevice, band, channel);
  81     }
  82 }
  83
  84 // index is zero origin, zero = power off completely
  85 void vtxCommonSetPowerByIndex(vtxDevice_t *vtxDevice, uint8_t index)
  86 {
  87     if (!vtxDevice)
  88         return;
  89
  90     if (index > vtxDevice->capability.powerCount)
  91         return;
  92
  93     if (vtxDevice->vTable->setPowerByIndex) {
  94         vtxDevice->vTable->setPowerByIndex(vtxDevice, index);
  95     }
  96 }
  97
  98 // on = 1, off = 0
  99 void vtxCommonSetPitMode(vtxDevice_t *vtxDevice, uint8_t onoff)
 100 {
 101     if (vtxDevice && vtxDevice->vTable->setPitMode) {
 102         vtxDevice->vTable->setPitMode(vtxDevice, onoff);
 103     }
 104 }
 105
 106 bool vtxCommonGetBandAndChannel(vtxDevice_t *vtxDevice, uint8_t *pBand, uint8_t *pChannel)
 107 {
 108     if (vtxDevice && vtxDevice->vTable->getBandAndChannel) {
 109         return vtxDevice->vTable->getBandAndChannel(vtxDevice, pBand, pChannel);
 110     }
 111     return false;
 112 }
 113
 114 bool vtxCommonGetPowerIndex(vtxDevice_t *vtxDevice, uint8_t *pIndex)
 115 {
 116     if (vtxDevice && vtxDevice->vTable->getPowerIndex) {
 117         return vtxDevice->vTable->getPowerIndex(vtxDevice, pIndex);
 118     }
 119     return false;
 120 }
 121
 122 bool vtxCommonGetPitMode(vtxDevice_t *vtxDevice, uint8_t *pOnOff)
 123 {
 124     if (vtxDevice && vtxDevice->vTable->getPitMode) {
 125         return vtxDevice->vTable->getPitMode(vtxDevice, pOnOff);
 126     }
 127     return false;
 128 }
 129
 130 bool vtxCommonGetFrequency(const vtxDevice_t *vtxDevice, uint16_t *pFrequency)
 131 {
 132     if (vtxDevice && vtxDevice->vTable->getFrequency) {
 133         return vtxDevice->vTable->getFrequency(vtxDevice, pFrequency);
 134     }
 135     return false;
 136 }
 137
 138 bool vtxCommonGetDeviceCapability(vtxDevice_t *vtxDevice, vtxDeviceCapability_t *pDeviceCapability)
 139 {
 140     if (vtxDevice) {
 141         memcpy(pDeviceCapability, &vtxDevice->capability, sizeof(vtxDeviceCapability_t));
 142         return true;
 143     }
 144     return false;
 145 }
 146
 147 bool vtxCommonGetPower(const vtxDevice_t *vtxDevice, uint8_t *pIndex, uint16_t *pPowerMw)
 148 {
 149     if (vtxDevice && vtxDevice->vTable->getPower) {
 150         return vtxDevice->vTable->getPower(vtxDevice, pIndex, pPowerMw);
 151     }
 152     return false;
 153 }
 154
 155 bool vtxCommonGetOsdInfo(vtxDevice_t *vtxDevice, vtxDeviceOsdInfo_t * pOsdInfo)
 156 {
 157     bool ret = false;
 158
 159     if (vtxDevice && vtxDevice->vTable->getOsdInfo) {
 160         ret = vtxDevice->vTable->getOsdInfo(vtxDevice, pOsdInfo);
 161     }
 162
 163     // Make sure we provide sane results even in case API fails
 164     if (!ret) {
 165         pOsdInfo->band = 0;
 166         pOsdInfo->channel = 0;
 167         pOsdInfo->frequency = 0;
 168         pOsdInfo->powerIndex = 0;
 169         pOsdInfo->powerMilliwatt = 0;
 170         pOsdInfo->bandLetter = '-';
 171         pOsdInfo->bandName = "-";
 172         pOsdInfo->channelName = "-";
 173         pOsdInfo->powerIndexLetter = '0';
 174     }
 175
 176     return ret;
 177 }