radio.h

/* Copyright 2023 Dual Tachyon
 * https://github.com/DualTachyon
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 *     Unless required by applicable law or agreed to in writing, software
 *     distributed under the License is distributed on an "AS IS" BASIS,
 *     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *     See the License for the specific language governing permissions and
 *     limitations under the License.
 */

#ifndef RADIO_H
#define RADIO_H

#include <stdbool.h>
#include <stdint.h>

#include "dcs.h"
#include "frequencies.h"

enum {
    RADIO_CHANNEL_UP   = 0x01u,
    RADIO_CHANNEL_DOWN = 0xFFu,
};

enum {
    BANDWIDTH_WIDE = 0,
    BANDWIDTH_NARROW
};

enum PTT_ID_t {
    PTT_ID_OFF = 0,    // OFF
    PTT_ID_TX_UP,      // BEGIN OF TX
    PTT_ID_TX_DOWN,    // END OF TX
    PTT_ID_BOTH,       // BOTH
    PTT_ID_APOLLO      // Apolo quindar tones
};
typedef enum PTT_ID_t PTT_ID_t;

enum VfoState_t
{
    VFO_STATE_NORMAL = 0,
    VFO_STATE_BUSY,
    VFO_STATE_BAT_LOW,
    VFO_STATE_TX_DISABLE,
    VFO_STATE_TIMEOUT,
    VFO_STATE_ALARM,
    VFO_STATE_VOLTAGE_HIGH,
    _VFO_STATE_LAST_ELEMENT
};
typedef enum VfoState_t VfoState_t;

typedef enum {
    MODULATION_FM,
    MODULATION_AM,
    MODULATION_USB,

#ifdef ENABLE_BYP_RAW_DEMODULATORS
    MODULATION_BYP,
	MODULATION_RAW,
#endif

    MODULATION_UKNOWN
} ModulationMode_t;

extern const char gModulationStr[MODULATION_UKNOWN][4];

typedef struct
{
    uint32_t       Frequency;
    DCS_CodeType_t CodeType;
    uint8_t        Code;
    uint8_t        Padding[2];
} FREQ_Config_t;

typedef struct VFO_Info_t
{
    FREQ_Config_t  freq_config_RX;
    FREQ_Config_t  freq_config_TX;

    // this is for a purpose of the FrequencyReverse function
    // it points to freq_config_RX normally and to freq_config_TX if reverse function is active
    //
    FREQ_Config_t *pRX;

    // this is for a purpose of the FrequencyReverse function
    // it points to freq_config_TX normally and to freq_config_RX if reverse function is active
    FREQ_Config_t *pTX;

    uint32_t       TX_OFFSET_FREQUENCY;
    uint16_t       StepFrequency;

    uint8_t        CHANNEL_SAVE;

    uint8_t        TX_OFFSET_FREQUENCY_DIRECTION;

    uint8_t        SquelchOpenRSSIThresh;
    uint8_t        SquelchOpenNoiseThresh;
    uint8_t        SquelchCloseGlitchThresh;
    uint8_t        SquelchCloseRSSIThresh;
    uint8_t        SquelchCloseNoiseThresh;
    uint8_t        SquelchOpenGlitchThresh;

    STEP_Setting_t STEP_SETTING;
    uint8_t        OUTPUT_POWER;
    uint8_t        TXP_CalculatedSetting;
    bool           FrequencyReverse;

    uint8_t        SCRAMBLING_TYPE;
    uint8_t        CHANNEL_BANDWIDTH;

    uint8_t        SCANLIST1_PARTICIPATION;
    uint8_t        SCANLIST2_PARTICIPATION;

    uint8_t        Band;
#ifdef ENABLE_DTMF_CALLING
    uint8_t        DTMF_DECODING_ENABLE;
#endif
    PTT_ID_t       DTMF_PTT_ID_TX_MODE;

    uint8_t        BUSY_CHANNEL_LOCK;

    ModulationMode_t    Modulation;

    uint8_t        Compander;

    char           Name[16];
} VFO_Info_t;

// Settings of the main VFO that is selected by the user
// The pointer follows gEeprom.TX_VFO index
extern VFO_Info_t    *gTxVfo;

// Settings of the actual VFO that is now used for RX,
// It is being alternated by dual watch, and flipped by crossband
// The pointer follows gEeprom.RX_VFO
extern VFO_Info_t    *gRxVfo;

// Equal to gTxVfo unless dual watch changes it on incomming transmition (this can only happen when XB off and DW on)
extern VFO_Info_t    *gCurrentVfo;

extern DCS_CodeType_t gCurrentCodeType;

extern VfoState_t     VfoState[2];

bool     RADIO_CheckValidChannel(uint16_t channel, bool checkScanList, uint8_t scanList);
uint8_t  RADIO_FindNextChannel(uint8_t ChNum, int8_t Direction, bool bCheckScanList, uint8_t RadioNum);
void     RADIO_InitInfo(VFO_Info_t *pInfo, const uint8_t ChannelSave, const uint32_t Frequency);
void     RADIO_ConfigureChannel(const unsigned int VFO, const unsigned int configure);
void     RADIO_ConfigureSquelchAndOutputPower(VFO_Info_t *pInfo);
void     RADIO_ApplyOffset(VFO_Info_t *pInfo);
void     RADIO_SelectVfos(void);
void RADIO_SetupRegisters(bool switchToForeground);
#ifdef ENABLE_NOAA
void RADIO_ConfigureNOAA(void);
#endif
void     RADIO_SetTxParameters(void);
void     RADIO_SetModulation(ModulationMode_t modulation);
void     RADIO_SetVfoState(VfoState_t State);
void     RADIO_PrepareTX(void);
void     RADIO_SendCssTail(void);
void     RADIO_PrepareCssTX(void);
void     RADIO_SendEndOfTransmission(void);
void RADIO_SetupAGC(bool listeningAM, bool disable);

#endif