portapack-mayhem/firmware/application/clock_manager.hpp
jLynx 033c4e9a5b
Formatted code (#1007)
* Updated style

* Updated files

* fixed new line

* Updated spacing

* File fix WIP

* Updated to clang 13

* updated comment style

* Removed old comment code
2023-05-19 08:16:05 +12:00

102 lines
2.7 KiB
C++

/*
* Copyright (C) 2014 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 __CLOCK_MANAGER_H__
#define __CLOCK_MANAGER_H__
#include "ch.h"
#include "hal.h"
#include "i2c_pp.hpp"
#include "si5351.hpp"
#include "lpc43xx_cpp.hpp"
using namespace lpc43xx;
class ClockManager {
public:
enum ReferenceSource {
Xtal, /* 10 MHz crystal onboard the HackRF */
PortaPack, /* 10 MHz TCXO on 20180820 and newer PortaPack revisions. */
External, /* HackRF external clock input SMA, or from PortaPack with TCXO feature. */
};
using ReferenceFrequency = uint32_t;
typedef struct {
ReferenceSource source;
ReferenceFrequency frequency;
} Reference;
constexpr ClockManager(
I2C& i2c0,
si5351::Si5351& clock_generator)
: i2c0(i2c0),
clock_generator(clock_generator),
reference({ReferenceSource::Xtal, 10000000}) {
}
void init_clock_generator();
void shutdown();
void start_audio_pll();
void stop_audio_pll();
void set_base_audio_clock_divider(const size_t divisor);
void enable_codec_clocks();
void disable_codec_clocks();
void enable_if_clocks();
void disable_if_clocks();
void set_sampling_frequency(const uint32_t frequency);
void set_reference_ppb(const int32_t ppb);
uint32_t get_frequency_monitor_measurement_in_hertz();
Reference get_reference() const;
void enable_clock_output(bool enable);
private:
I2C& i2c0;
si5351::Si5351& clock_generator;
Reference reference;
void set_gp_clkin_to_clkin_direct();
void start_frequency_monitor_measurement(const cgu::CLK_SEL clk_sel);
void wait_For_frequency_monitor_measurement_done();
void set_m4_clock_to_irc();
void set_m4_clock_to_pll1();
uint32_t measure_gp_clkin_frequency();
ReferenceSource detect_reference_source();
Reference choose_reference();
bool loss_of_signal();
};
#endif /*__CLOCK_MANAGER_H__*/