/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2015 Matthias P. Braendli
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
*/

#ifndef _FSM_H_
#define _FSM_H_

// List of all states the FSM of the relay can be in
enum fsm_state_e {
    FSM_OISIF = 0,       // Idle
    FSM_OPEN1,           // 1750 Hz received and squelch open
    FSM_OPEN2,           // Squelch closed
    FSM_LETTRE,          // Transmit single status letter
    FSM_ECOUTE,          // Repeater open, waiting for QSO
    FSM_ATTENTE,         // No QSO after a short while
    FSM_QSO,             // QSO ongoing
    FSM_ANTI_BAVARD,     // QSO too long, cut transmission
    FSM_BLOQUE,          // Backoff after ANTI_BAVARD
    FSM_TEXTE_73,        // Transmit 73 after QSO
    FSM_TEXTE_HB9G,      // Transmit HB9G after QSO
    FSM_TEXTE_LONG,      // Transmit either HB9G JN36BK or HB9G 1628M after QSO
    FSM_BALISE_LONGUE,   // Full-length 2-hour beacon
    FSM_BALISE_SPECIALE, // 2-hour beacon when in QRP or with high power return mode
    FSM_BALISE_COURTE,   // Short intermittent beacon
    _NUM_FSM_STATES      // Dummy state to count the number of states
};

typedef enum fsm_state_e fsm_state_t;

// All signals that the FSM can read, most of them are actually booleans
struct fsm_input_signals_t {
    /* Signals coming from repeater electronics */
    int sq;                // Squelch detection
    int discrim_u;         // FM discriminator says RX is too high in frequency
    int carrier;           // RX carrier detection
    int qrp;               // The relay is currently running with low power
    int start_tm;          // 2-hour pulse
    float temp;            // temperature in degrees C
    float humidity;        // relative humidity, range [0-100] %
    int wind_generator_ok; // false if the generator is folded out of the wind
    int discrim_d;         // FM discriminator says RX is too low in frequency
    int tone_1750;         // Detect 1750Hz tone
    int sstv_mode;         // The 1750Hz filter is disabled, permitting SSTV usage

    /* Signals coming from CW generator */
    int cw_done;           // The CW generator has finished transmitting the message

    /* Signal coming from the standing wave ratio meter */
    int swr_high;          // We see a lot of return power

};

// All signals the FSM has to control
struct fsm_output_signals_t {
    /* Signals to the repeater electronics */
    int qrp;            // Place the repeater in QRP mode
    int tx_on;          // Enable TX circuitry
    int modulation;     // Enable repeater RX to TX modulation

    /* Signals to the CW generator */
    const char* cw_msg; // The message to transmit
    int cw_frequency;   // What audio frequency for the CW message
    int cw_speed;       // CW speed
    int cw_trigger;     // Set to true to trigger a transmission
};

// Initialise local structures
void fsm_init();

// Call the FSM once and update the internal state
void fsm_update();

// Setter for inputs
void fsm_update_inputs(struct fsm_input_signals_t* inputs);

// Getter for outputs
void fsm_get_outputs(struct fsm_output_signals_t* out);

#endif // _FSM_H_