portapack-mayhem/firmware/application/receiver_model.hpp

/*
 * Copyright (C) 2015 Jared Boone, ShareBrained Technology, Inc.
 *
 * This file is part of PortaPack.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2, or (at your option)
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __RECEIVER_MODEL_H__
#define __RECEIVER_MODEL_H__

#include <cstdint>
#include <cstddef>

#include "message.hpp"
#include "rf_path.hpp"
#include "max2837.hpp"
#include "volume.hpp"

struct BasebandConfiguration {
	int32_t mode;
	uint32_t sampling_rate;
	size_t decimation_factor;

	constexpr BasebandConfiguration(
		int32_t mode,
		uint32_t sampling_rate,
		size_t decimation_factor = 1
	) : mode { mode },
		sampling_rate { sampling_rate },
		decimation_factor { decimation_factor }
	{
	}

	constexpr BasebandConfiguration(
	) : BasebandConfiguration { -1, 0, 1 }
	{
	}
};

class ReceiverModel {
public:
	enum class Mode {
		AMAudio = 0,
		NarrowbandFMAudio = 1,
		WidebandFMAudio = 2,
		SpectrumAnalysis = 3,
	};

	rf::Frequency tuning_frequency() const;
	void set_tuning_frequency(rf::Frequency f);

	rf::Frequency frequency_step() const;
	void set_frequency_step(rf::Frequency f);

	bool antenna_bias() const;
	void set_antenna_bias(bool enabled);

	bool rf_amp() const;
	void set_rf_amp(bool enabled);

	int32_t lna() const;
	void set_lna(int32_t v_db);

	uint32_t baseband_bandwidth() const;
	void set_baseband_bandwidth(uint32_t v);

	int32_t vga() const;
	void set_vga(int32_t v_db);

	uint32_t sampling_rate() const;
	void set_sampling_rate(uint32_t v);

	Mode modulation() const;
	void set_modulation(Mode v);

	volume_t headphone_volume() const;
	void set_headphone_volume(volume_t v);

	uint32_t baseband_oversampling() const;

	void enable();
	void disable();

	size_t am_configuration() const;
	void set_am_configuration(const size_t n);

	size_t nbfm_configuration() const;
	void set_nbfm_configuration(const size_t n);

	size_t wfm_configuration() const;
	void set_wfm_configuration(const size_t n);

private:
	rf::Frequency frequency_step_ { 25000 };
	bool enabled_ { false };
	bool rf_amp_ { false };
	bool antenna_bias_ { false };
	int32_t lna_gain_db_ { 32 };
	uint32_t baseband_bandwidth_ { max2837::filter::bandwidth_minimum };
	int32_t vga_gain_db_ { 32 };
	Mode mode_ { Mode::NarrowbandFMAudio };
	uint32_t sampling_rate_ { 3072000 };
	size_t decimation_factor_ { 1 };
	size_t am_config_index = 0;
	size_t nbfm_config_index = 0;
	size_t wfm_config_index = 0;
	volume_t headphone_volume_ { -43.0_dB };

	int32_t tuning_offset();

	void update_tuning_frequency();
	void update_antenna_bias();
	void update_rf_amp();
	void update_lna();
	void update_baseband_bandwidth();
	void update_vga();
	void update_sampling_rate();
	void update_headphone_volume();

	void update_modulation();
	void update_am_configuration();
	void update_nbfm_configuration();
	void update_wfm_configuration();
};

#endif/*__RECEIVER_MODEL_H__*/