/* * 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. */ #include "clock_manager.hpp" #include "portapack_persistent_memory.hpp" #include "portapack_io.hpp" #include "portapack.hpp" #include "lpc43xx.inc" #include "hackrf_hal.hpp" using namespace hackrf::one; #include "lpc43xx_cpp.hpp" using namespace lpc43xx; #ifdef PRALINE #include "hackrf_gpio.hpp" #include "gpio.hpp" #endif #ifdef PRALINE extern "C" { #include "fpga_bridge.h" } // Need access to ssp1_arbiter from radio namespace for FPGA related radio method dependencies. #include "radio.hpp" #endif constexpr uint32_t si5351_vco_f = 800000000; #ifdef PRALINE constexpr uint32_t si5351_vco_afe_f = 800000000; // If necessary may be changed to 768 MHz for optimal for 3.072 MHz sample frequencies commonly used by apps #endif constexpr si5351::Inputs si5351_inputs{ .f_xtal = si5351_xtal_f, .f_clkin = si5351_clkin_f, .clkin_div = 1, }; static_assert(si5351_inputs.f_xtal == si5351_xtal_f, "XTAL output frequency wrong"); static_assert(si5351_inputs.f_clkin_out() == si5351_clkin_f, "CLKIN output frequency wrong"); constexpr si5351::PLLInputSource::Type si5351c_pll_input_sources{ si5351::PLLInputSource::PLLA_Source_XTAL | si5351::PLLInputSource::PLLB_Source_CLKIN | si5351::PLLInputSource::CLKIN_Div1}; constexpr si5351::PLLInputSource::Type si5351a_pll_input_sources{ si5351::PLLInputSource::PLLA_Source_XTAL | si5351::PLLInputSource::PLLB_Source_XTAL | si5351::PLLInputSource::CLKIN_Div1}; constexpr si5351::PLL si5351_pll_xtal_25m{ .f_in = si5351_inputs.f_xtal, .a = 32, .b = 0, .c = 1, }; #ifdef PRALINE // Define pll_a from 25MHz clock for stable PLL A, and AFE locked reference // PLL A: 800 MHz VCO (32x Multiplier for jitter-free 3.072 MHz sampling) constexpr si5351::PLL si5351_pll_a_afe_800m{ .f_in = si5351_inputs.f_xtal, // 25,000,000 Hz .a = 32, // Multiplier: 25 * 32 = 800 .b = 0, .c = 1, }; // PLL A: registers (Base 34) 800 MHz VCO (For jitter-free AFE sampling frequencies) constexpr auto si5351_pll_a_800_reg = si5351_pll_a_afe_800m.reg(0); // Base 26 static_assert(si5351_pll_a_afe_800m.f_vco() == si5351_vco_f, "PLL A XTAL frequency wrong"); static_assert(si5351_pll_a_afe_800m.p1() == 3584, "PLL A XTAL P1 wrong"); static_assert(si5351_pll_a_afe_800m.p2() == 0, "PLL A XTAL P2 wrong"); static_assert(si5351_pll_a_afe_800m.p3() == 1, "PLL A XTAL P3 wrong"); // Define pll_b 25MHz clock for stable PLL B // PLL B: 800 MHz VCO (32x Multiplier for (For stable Digital/SGPIO bus) constexpr si5351::PLL si5351_pll_b_800m{ .f_in = si5351_inputs.f_xtal, // 25,000,000 Hz .a = 32, // Multiplier: 25 * 32 = 800 .b = 0, .c = 1, }; // PLL B: registers (Base 34) 800 MHz VCO (For stable Digital/SGPIO bus) constexpr auto si5351_pll_b_800_reg = si5351_pll_b_800m.reg(1); // Base 34 static_assert(si5351_pll_b_800m.f_vco() == si5351_vco_f, "PLL B XTAL frequency wrong"); static_assert(si5351_pll_b_800m.p1() == 3584, "PLL B XTAL P1 wrong"); static_assert(si5351_pll_b_800m.p2() == 0, "PLL B XTAL P2 wrong"); static_assert(si5351_pll_b_800m.p3() == 1, "PLL B XTAL P3 wrong"); #else // PLL A registers (Base 26) constexpr auto si5351_pll_a_xtal_reg = si5351_pll_xtal_25m.reg(0); static_assert(si5351_pll_xtal_25m.f_vco() == si5351_vco_f, "PLL XTAL frequency wrong"); static_assert(si5351_pll_xtal_25m.p1() == 3584, "PLL XTAL P1 wrong"); static_assert(si5351_pll_xtal_25m.p2() == 0, "PLL XTAL P2 wrong"); static_assert(si5351_pll_xtal_25m.p3() == 1, "PLL XTAL P3 wrong"); #endif constexpr si5351::PLL si5351_pll_clkin_10m{ .f_in = si5351_inputs.f_clkin_out(), .a = 80, .b = 0, .c = 1, }; constexpr auto si5351c_pll_b_clkin_reg = si5351_pll_clkin_10m.reg(1); constexpr auto si5351a_pll_a_clkin_reg = si5351_pll_clkin_10m.reg(0); static_assert(si5351_pll_clkin_10m.f_vco() == si5351_vco_f, "PLL CLKIN frequency wrong"); static_assert(si5351_pll_clkin_10m.p1() == 9728, "PLL CLKIN P1 wrong"); static_assert(si5351_pll_clkin_10m.p2() == 0, "PLL CLKIN P2 wrong"); static_assert(si5351_pll_clkin_10m.p3() == 1, "PLL CLKIN P3 wrong"); /* constexpr si5351::MultisynthFractional si5351_ms_18m432 { .f_src = si5351_vco_f, .a = 43, .b = 29, .c = 72, .r_div = 1, }; */ // constexpr auto si5351_ms_0_20m_reg = si5351_ms_0_20m.reg(0); constexpr si5351::MultisynthFractional si5351_ms_0_4m{ .f_src = si5351_vco_f, // 800,000,000 Hz .a = 100, // Integer divider 100 .b = 0, .c = 1, .r_div = 1 // Final R-divider: 2^1 = 2 }; constexpr si5351::MultisynthFractional si5351_ms_0_8m{ .f_src = si5351_vco_f, .a = 50, .b = 0, .c = 1, .r_div = 1, }; #ifdef PRALINE // (initial 4 MHz from 800 MHz VCO: 800 / 200 = 4) constexpr si5351::MultisynthFractional si5351_ms_afe_4m{ .f_src = si5351_vco_afe_f, // 800 MHz .a = 200, .b = 0, .c = 1, .r_div = 0}; // (10 MHz from 800 MHz VCO: 800 / 80 = 10) constexpr si5351::MultisynthFractional si5351_ms_afe_10m{ .f_src = si5351_vco_afe_f, // 800 MHz .a = 80, .b = 0, .c = 1, .r_div = 0}; // (20 MHz from 800 MHz VCO: 800 / 40 = 20) constexpr si5351::MultisynthFractional si5351_ms_afe_20m{ .f_src = si5351_vco_afe_f, .a = 40, .b = 0, .c = 1, .r_div = 0, }; // (25 MHz from 800 MHz VCO: 800 / 32 = 25) // Define xtal MultiSynth 25MHz clock for stable PLL A, and AFE locked XTAL reference constexpr si5351::MultisynthFractional si5351_ms_afe_25m{ .f_src = si5351_vco_afe_f, // 800,000,000 Hz .a = 32, // 800 / 32 = 25 MHz .b = 0, .c = 1, .r_div = 0 // No final bit-shifting }; // (40 MHz from 800 MHz VCO: 800 / 20 = 40) constexpr si5351::MultisynthFractional si5351_ms_afe_40m{ .f_src = si5351_vco_afe_f, // 800 MHz .a = 20, .b = 0, .c = 1, .r_div = 0}; // (20 MHz from 800 MHz VCO: 800 / 40 = 20) constexpr si5351::MultisynthFractional si5351_ms_20m{ .f_src = si5351_vco_f, .a = 40, .b = 0, .c = 1, .r_div = 0, }; // constexpr auto si5351_ms_20m_reg = si5351_ms_20m.reg(0); // (25 MHz from 800 MHz VCO: 800 / 32 = 25) // Define xtal MultiSynth 25MHz clock for stable PLL B, and XTAL reference constexpr si5351::MultisynthFractional si5351_ms_25m{ .f_src = si5351_vco_f, // 800,000,000 Hz .a = 32, // 800 / 32 = 25 MHz .b = 0, .c = 1, .r_div = 0 // No final bit-shifting }; #endif constexpr auto si5351c_ms_0_8m_reg = si5351_ms_0_8m.reg(clock_generator_output_og_codec); #ifdef PRALINE // Verify compile-time values for 8 MHz config static_assert(si5351_ms_0_8m.p1() == 5888, "MS0 8MHz P1 should be 5888 (0x1700)"); static_assert(si5351_ms_0_8m.p2() == 0, "MS0 8MHz P2 should be 0"); static_assert(si5351_ms_0_8m.p3() == 1, "MS0 8MHz P3 should be 1"); static_assert(si5351_ms_0_8m.f_out() == 8000000, "MS0 should output 8 MHz"); // Verify register array encoding static_assert(si5351c_ms_0_8m_reg[0] == 42, "MS0 base register should be 42"); static_assert(si5351c_ms_0_8m_reg[1] == 0x00, "MS0 reg43 P3[15:8] should be 0x00"); static_assert(si5351c_ms_0_8m_reg[2] == 0x01, "MS0 reg44 P3[7:0] should be 0x01"); static_assert(si5351c_ms_0_8m_reg[3] == 0x10, "MS0 reg45 R_DIV should be 0x10"); static_assert(si5351c_ms_0_8m_reg[4] == 0x17, "MS0 reg46 P1[15:8] should be 0x17"); static_assert(si5351c_ms_0_8m_reg[5] == 0x00, "MS0 reg47 P1[7:0] should be 0x00"); #endif constexpr si5351::MultisynthFractional si5351_ms_group{ .f_src = si5351_vco_f, .a = 80, /* Don't care */ .b = 0, .c = 1, .r_div = 0, }; constexpr auto si5351c_ms_1_group_reg = si5351_ms_group.reg(clock_generator_output_og_cpld); constexpr auto si5351c_ms_2_group_reg = si5351_ms_group.reg(clock_generator_output_og_sgpio); constexpr si5351::MultisynthFractional si5351_ms_16m{ .f_src = si5351_vco_f, .a = 50, .b = 0, .c = 1, .r_div = 0, }; constexpr auto si5351a_ms_1_sgpio_16m_reg = si5351_ms_16m.reg(clock_generator_output_r9_sgpio); constexpr si5351::MultisynthFractional si5351_ms_10m{ .f_src = si5351_vco_f, .a = 80, .b = 0, .c = 1, .r_div = 0, }; constexpr auto si5351c_ms_3_10m_reg = si5351_ms_10m.reg(3); constexpr auto si5351a_ms_2_mcu_10m_reg = si5351_ms_10m.reg(clock_generator_output_r9_mcu_clkin); constexpr si5351::MultisynthFractional si5351_ms_40m{ .f_src = si5351_vco_f, .a = 20, .b = 0, .c = 1, .r_div = 0, }; constexpr auto si5351_ms_rffc5072 = si5351_ms_40m; constexpr auto si5351_ms_max283x = si5351_ms_40m; constexpr auto si5351c_ms_4_reg = si5351_ms_rffc5072.reg(clock_generator_output_og_first_if); constexpr auto si5351c_ms_5_reg = si5351_ms_max283x.reg(clock_generator_output_og_second_if); constexpr auto si5351a_ms_0_if_40m_reg = si5351_ms_40m.reg(clock_generator_output_r9_if); static_assert(si5351_ms_10m.f_out() == 10000000, "MS 10MHz f_out wrong"); static_assert(si5351_ms_10m.p1() == 9728, "MS 10MHz p1 wrong"); static_assert(si5351_ms_10m.p2() == 0, "MS 10MHz p2 wrong"); static_assert(si5351_ms_10m.p3() == 1, "MS 10MHz p3 wrong"); static_assert(si5351_ms_rffc5072.f_out() == rffc5072_reference_f, "RFFC5072 reference f_out wrong"); static_assert(si5351_ms_max283x.f_out() == max283x_reference_f, "MAX283x reference f_out wrong"); constexpr si5351::MultisynthInteger si5351_ms_int_off{ .f_src = si5351_vco_f, .a = 255, .r_div = 0, }; constexpr si5351::MultisynthInteger si5351_ms_int_40m{ .f_src = si5351_vco_f, .a = 20, .r_div = 0, }; constexpr si5351::MultisynthInteger si5351_ms_int_10m{ .f_src = si5351_vco_f, .a = 80, .r_div = 0, }; constexpr auto si5351c_ms_int_mcu_clkin = si5351_ms_int_40m; constexpr auto si5351a_ms_int_mcu_clkin = si5351_ms_int_10m; constexpr auto si5351c_ms6_7_off_mcu_clkin_reg = si5351::ms6_7_reg(si5351_ms_int_off, si5351c_ms_int_mcu_clkin); constexpr auto si5351a_ms6_7_off_reg = si5351::ms6_7_reg(si5351_ms_int_off, si5351_ms_int_off); static_assert(si5351_ms_int_off.f_out() == 3137254, "MS int off f_out wrong"); static_assert(si5351_ms_int_off.p1() == 255, "MS int off P1 wrong"); static_assert(si5351c_ms_int_mcu_clkin.f_out() == mcu_clkin_og_f, "MS int MCU CLKIN OG f_out wrong"); static_assert(si5351a_ms_int_mcu_clkin.f_out() == mcu_clkin_r9_f, "MS int MCU CLKIN r9 f_out wrong"); using namespace si5351; #ifdef PRALINE static constexpr ClockControl::MultiSynthSource get_si5351a_reference_clock_generator_pll(const ClockManager::ReferenceSource reference_source) { return (reference_source == ClockManager::ReferenceSource::Xtal) ? ClockControl::MultiSynthSource::PLLA : ClockControl::MultiSynthSource::PLLB; } static constexpr ClockControl::MultiSynthSource get_si5351c_reference_clock_generator_pll(const ClockManager::ReferenceSource reference_source) { return (reference_source == ClockManager::ReferenceSource::Xtal) ? ClockControl::MultiSynthSource::PLLA : ClockControl::MultiSynthSource::PLLB; } #else static constexpr ClockControl::MultiSynthSource get_si5351c_reference_clock_generator_pll(const ClockManager::ReferenceSource reference_source) { return (reference_source == ClockManager::ReferenceSource::Xtal) ? ClockControl::MultiSynthSource::PLLA : ClockControl::MultiSynthSource::PLLB; } #endif #ifndef PRALINE constexpr ClockControls si5351c_clock_control_common{{ {ClockControl::ClockCurrentDrive::_8mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Fractional, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Group, ClockControl::ClockInvert::Invert, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Group, ClockControl::ClockInvert::Normal, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_8mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_6mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Invert, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_4mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Fractional, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, get_si5351c_reference_clock_generator_pll(ClockManager::ReferenceSource::Xtal), ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, }}; #endif constexpr ClockControls si5351a_clock_control_common{{ #ifdef PRALINE // CLK0: MAX5864 (ADC) - 4mA, Normal PLLA Integer {ClockControl::ClockCurrentDrive::_4mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_On}, // CLK1: SCT_CLK (iCE40 FPGA) - 4mA, Normal PLLB Integer {ClockControl::ClockCurrentDrive::_4mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLB, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_On}, // CLK2: LPC43xx MCU - 2mA, Normal PLLA (Must be Integer for MCU stability) {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_On}, // CLK3: CLKOUT SMA Port P1 - 2mA, Normal PLLB Integer Power_Off {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLB, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, // CLK4: MAX2831 reference (40 MHz) - 4mA, Invert PLLA Integer (Required for mixer lock) {ClockControl::ClockCurrentDrive::_4mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Invert, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_On}, // CLK5: RFFC5072 reference (40 MHz) - 4mA, Invert PLLA Integer (Required for mixer lock) {ClockControl::ClockCurrentDrive::_4mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Invert, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_On}, // CLK6: Not used (disabled) 2mA, Normal PLLB Integer, Power_Off {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLB, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, // CLK7: Not used (disabled) 2mA, Normal PLLB Integer, Power_Off {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLB, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, #else {ClockControl::ClockCurrentDrive::_6mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_4mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Fractional, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_8mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, // CLK4: HackRF r9 - not inverted {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, // CLK5: HackRF r9 - not used {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, // CLK6: Not used {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, // CLK7: Not used {ClockControl::ClockCurrentDrive::_2mA, ClockControl::ClockSource::MS_Self, ClockControl::ClockInvert::Normal, ClockControl::MultiSynthSource::PLLA, ClockControl::MultiSynthMode::Integer, ClockControl::ClockPowerDown::Power_Off}, #endif }}; ClockManager::Reference ClockManager::get_reference() const { return reference; } std::string ClockManager::get_source() { std::string source_name("---"); switch (reference.source) { case ClockManager::ReferenceSource::Xtal: source_name = "HackRF"; break; case ClockManager::ReferenceSource::PortaPack: source_name = "PortaPack"; break; case ClockManager::ReferenceSource::External: source_name = "External"; break; } return source_name; } std::string ClockManager::get_freq() { return to_string_dec_uint(reference.frequency / 1000000, 2) + "." + to_string_dec_uint((reference.frequency % 1000000) / 100, 4, '0') + " MHz"; } void ClockManager::portapack_tcxo_enable() { #ifdef PRALINE gpio_control::clkin_ctrl.setActive(); set_p1_control(P1_Function::P22_ClkIn); #endif portapack::io.reference_oscillator(true); /* Delay >10ms at 96MHz clock speed for reference oscillator to start. */ /* Delay an additional 1ms (arbitrary) for the clock generator to detect a signal. */ volatile uint32_t delay = 240000 + 24000; while (delay--); } void ClockManager::portapack_tcxo_disable() { #ifdef PRALINE gpio_control::clkin_ctrl.setInactive(); #endif portapack::io.reference_oscillator(false); } #include "hackrf_gpio.hpp" using namespace hackrf::one; void ClockManager::init_clock_generator() { if (hackrf_r9) { gpio_r9_mcu_clk_en.output(); gpio_r9_mcu_clk_en.write(1); } clock_generator.reset(); clock_generator.set_crystal_internal_load_capacitance(CrystalInternalLoadCapacitance::XTAL_CL_8pF); clock_generator.enable_fanout(); #ifdef PRALINE constexpr size_t clock_generator_output_pro_mcu_clkin = 2; auto si5351_clock_control_common = si5351a_clock_control_common; /* * Match the HackRF One init flow: * 1. PLLA stays on the local 25MHz crystal. * 2. PLLB is configured from the Si5351 CLKIN pin. * 3. CLK2 temporarily drives GP_CLKIN directly from CLKIN so we can * detect whether P22 is carrying a valid 10MHz reference. * 4. Once the source is chosen, all runtime clocks are switched to the * selected PLL and the working multisynths are programmed. */ clock_generator.set_pll_input_sources(si5351c_pll_input_sources); clock_generator.set_clock_control( clock_generator_output_pro_mcu_clkin, si5351_clock_control_common[clock_generator_output_pro_mcu_clkin] .clk_src(ClockControl::ClockSource::CLKIN) .clk_pdn(ClockControl::ClockPowerDown::Power_On)); clock_generator.enable_output(clock_generator_output_pro_mcu_clkin); chThdSleepMilliseconds(20); reference = choose_reference(); clock_generator.disable_output(clock_generator_output_pro_mcu_clkin); const auto ref_pll = get_si5351c_reference_clock_generator_pll(reference.source); const ClockControls si5351_clock_control = ClockControls{{ si5351_clock_control_common[0].ms_src(ref_pll), si5351_clock_control_common[1].ms_src(ref_pll), si5351_clock_control_common[2].ms_src(ref_pll), si5351_clock_control_common[3].ms_src(ref_pll), si5351_clock_control_common[4].ms_src(ref_pll), si5351_clock_control_common[5].ms_src(ref_pll), si5351_clock_control_common[6].ms_src(ref_pll), si5351_clock_control_common[7].ms_src(ref_pll), }}; clock_generator.set_clock_control_single_byte(si5351_clock_control); #else clock_generator.set_pll_input_sources(hackrf_r9 ? si5351a_pll_input_sources : si5351c_pll_input_sources); auto si5351_clock_control_common = hackrf_r9 ? si5351a_clock_control_common : si5351c_clock_control_common; auto clock_generator_output_mcu_clkin = hackrf_r9 ? clock_generator_output_r9_mcu_clkin : clock_generator_output_og_mcu_clkin; clock_generator.set_clock_control( clock_generator_output_mcu_clkin, si5351_clock_control_common[clock_generator_output_mcu_clkin] .clk_src(hackrf_r9 ? ClockControl::ClockSource::Xtal : ClockControl::ClockSource::CLKIN) .clk_pdn(ClockControl::ClockPowerDown::Power_On)); clock_generator.enable_output(clock_generator_output_mcu_clkin); reference = choose_reference(); clock_generator.disable_output(clock_generator_output_mcu_clkin); const auto ref_pll = hackrf_r9 ? ClockControl::MultiSynthSource::PLLA : get_si5351c_reference_clock_generator_pll(reference.source); const ClockControls si5351_clock_control = ClockControls{{ si5351_clock_control_common[0].ms_src(ref_pll), si5351_clock_control_common[1].ms_src(ref_pll), si5351_clock_control_common[2].ms_src(ref_pll), si5351_clock_control_common[3].ms_src(ref_pll), si5351_clock_control_common[4].ms_src(ref_pll), si5351_clock_control_common[5].ms_src(ref_pll), si5351_clock_control_common[6].ms_src(ref_pll), si5351_clock_control_common[7].ms_src(ref_pll), }}; clock_generator.set_clock_control(si5351_clock_control); #endif #ifdef PRALINE clock_generator.write_pll_single_byte(0, si5351_pll_a_afe_800m); { const auto& pll_b = si5351c_pll_b_clkin_reg; for (size_t i = 1; i < pll_b.size(); i++) { clock_generator.write_register(pll_b[0] + i - 1, pll_b[i]); } } // CLK0: DAFE_CLK initial 4 MHz clock_generator.write_ms_single_byte( 0, si5351_ms_afe_4m); // CLK1: DSCT_CLK initial 10 MHz clock_generator.write_ms_single_byte( 1, si5351_ms_10m); // CLK2: MCU_CLK 40 MHz clock_generator.write_ms_single_byte( 2, si5351_ms_afe_40m); // CLK3: P2 clock mux, disabled below clock_generator.write_ms_single_byte( 3, si5351_ms_10m); // CLK4: DXCVR_CLK 40 MHz clock_generator.write_ms_single_byte( 4, si5351_ms_afe_40m); // CLK5: DMIX_CLK 40 MHz clock_generator.write_ms_single_byte( 5, si5351_ms_afe_40m); { const auto& ms6_7 = si5351a_ms6_7_off_reg; for (size_t i = 1; i < ms6_7.size(); i++) { clock_generator.write_register(ms6_7[0] + i - 1, ms6_7[i]); } } #else if (hackrf_r9) { const PLLReg pll_reg = (reference.source == ReferenceSource::Xtal) ? si5351_pll_a_xtal_reg : si5351a_pll_a_clkin_reg; clock_generator.write(pll_reg); clock_generator.write(si5351a_ms_0_if_40m_reg); clock_generator.write(si5351a_ms_1_sgpio_16m_reg); clock_generator.write(si5351a_ms_2_mcu_10m_reg); clock_generator.write(si5351a_ms6_7_off_reg); } else { clock_generator.write(si5351_pll_a_xtal_reg); clock_generator.write(si5351c_pll_b_clkin_reg); clock_generator.write(si5351c_ms_0_8m_reg); clock_generator.write(si5351c_ms_1_group_reg); clock_generator.write(si5351c_ms_2_group_reg); clock_generator.write(si5351c_ms_3_10m_reg); clock_generator.write(si5351c_ms_4_reg); clock_generator.write(si5351c_ms_5_reg); clock_generator.write(si5351c_ms6_7_off_mcu_clkin_reg); } #endif clock_generator.reset_plls(); // Wait for PLL(s) to lock. #ifdef PRALINE uint8_t device_status_mask = (ref_pll == ClockControl::MultiSynthSource::PLLB) ? 0x40 : 0x20; uint32_t pll_timeout = 100000; while ((clock_generator.device_status() & device_status_mask) != 0 && pll_timeout > 0) { pll_timeout--; } clock_generator.enable_output(clock_generator_output_pro_mcu_clkin); #else // Wait for PLL(s) to lock - with timeout to prevent hang uint8_t device_status_mask = hackrf_r9 ? 0x20 : (ref_pll == ClockControl::MultiSynthSource::PLLB) ? 0x40 : 0x20; while ((clock_generator.device_status() & device_status_mask) != 0); clock_generator.set_clock_control( clock_generator_output_mcu_clkin, si5351_clock_control_common[clock_generator_output_mcu_clkin].ms_src(ref_pll).clk_pdn(ClockControl::ClockPowerDown::Power_On)); clock_generator.enable_output(clock_generator_output_mcu_clkin); #endif } uint32_t ClockManager::measure_gp_clkin_frequency() { // Measure Si5351B CLKIN frequency against LPC43xx IRC oscillator start_frequency_monitor_measurement(cgu::CLK_SEL::GP_CLKIN); wait_For_frequency_monitor_measurement_done(); return get_frequency_monitor_measurement_in_hertz(); } bool ClockManager::loss_of_signal() { #ifdef PRALINE return clock_generator.clkin_loss_of_signal(); #else if (hackrf_r9) { const auto frequency = measure_gp_clkin_frequency(); return (frequency < 9850000) || (frequency > 10150000); } else { return clock_generator.clkin_loss_of_signal(); } #endif } ClockManager::ReferenceSource ClockManager::detect_reference_source() { if (portapack::persistent_memory::config_disable_external_tcxo()) return ReferenceSource::Xtal; if (loss_of_signal()) { // No external reference. Turn on PortaPack reference (if present). portapack_tcxo_enable(); if (loss_of_signal()) { // No PortaPack reference was detected. Choose the HackRF crystal as the reference. return ReferenceSource::Xtal; } else { return ReferenceSource::PortaPack; } } else { return ReferenceSource::External; } } ClockManager::Reference ClockManager::choose_reference() { #ifdef PRALINE const auto detected_reference = detect_reference_source(); if ((detected_reference == ReferenceSource::External) || (detected_reference == ReferenceSource::PortaPack)) { const auto frequency = measure_gp_clkin_frequency(); if ((frequency >= 9850000) && (frequency <= 10150000)) { return {detected_reference, 10000000}; } } #else if (hackrf_r9) { gpio_r9_clkin_en.write(1); volatile uint32_t delay = 240000 + 24000; while (delay--); } const auto detected_reference = detect_reference_source(); if ((detected_reference == ReferenceSource::External) || (detected_reference == ReferenceSource::PortaPack)) { const auto frequency = measure_gp_clkin_frequency(); if ((frequency >= 9850000) && (frequency <= 10150000)) { return {detected_reference, 10000000}; } } if (hackrf_r9) { gpio_r9_clkin_en.write(0); } #endif portapack_tcxo_disable(); return {ReferenceSource::Xtal, 25000000}; } void ClockManager::shutdown() { clock_generator.reset(); } void ClockManager::enable_codec_clocks() { #ifdef PRALINE /* PRALINE: only gate the clocks owned by the RF datapath here. * CLK2 is MCU_CLKIN and must stay independent of runtime RX/TX clock * management or the SGPIO/GPIO subsystem can glitch mid-stream. */ clock_generator.enable_clock(clock_generator_output_og_codec); /* CLK0 MAX5864*/ clock_generator.enable_clock(clock_generator_output_og_cpld); /* CLK1 iCE40 FPGA*/ clock_generator.enable_output_mask( (1U << clock_generator_output_og_codec) | (1U << clock_generator_output_og_cpld)); #else if (hackrf_r9) { clock_generator.enable_clock(clock_generator_output_r9_sgpio); } else { clock_generator.enable_clock(clock_generator_output_og_codec); clock_generator.enable_clock(clock_generator_output_og_cpld); clock_generator.enable_clock(clock_generator_output_og_sgpio); } /* Turn on all outputs at the same time. This probably doesn't ensure * their phase relationships. For example, clocks that output frequencies * in a 2:1 relationship may start with the slower clock high or low? */ if (hackrf_r9) { clock_generator.enable_output_mask(1U << clock_generator_output_r9_sgpio); } else { clock_generator.enable_output_mask( (1U << clock_generator_output_og_codec) | (1U << clock_generator_output_og_cpld) | (1U << clock_generator_output_og_sgpio)); } #endif } void ClockManager::disable_codec_clocks() { /* Turn off outputs before disabling clocks. It seems the clock needs to * be enabled for the output to come to rest at the state specified by * CLKx_DISABLE_STATE. */ #ifdef PRALINE /* PRALINE: leave CLK2/MCU_CLKIN alone; only disable datapath-owned clocks. */ clock_generator.disable_output_mask( (1U << clock_generator_output_og_codec) | (1U << clock_generator_output_og_cpld)); clock_generator.disable_clock(clock_generator_output_og_codec); clock_generator.disable_clock(clock_generator_output_og_cpld); #else if (hackrf_r9) { clock_generator.disable_output_mask(1U << clock_generator_output_r9_sgpio); clock_generator.disable_clock(clock_generator_output_r9_sgpio); } else { clock_generator.disable_output_mask( (1U << clock_generator_output_og_codec) | (1U << clock_generator_output_og_cpld) | (1U << clock_generator_output_og_sgpio)); clock_generator.disable_clock(clock_generator_output_og_codec); clock_generator.disable_clock(clock_generator_output_og_cpld); clock_generator.disable_clock(clock_generator_output_og_sgpio); } #endif } void ClockManager::enable_if_clocks() { #ifdef PRALINE /* PRALINE uses CLK5 (first IF) and CLK4 (second IF) */ clock_generator.enable_clock(clock_generator_output_og_first_if); clock_generator.enable_output_mask(1U << clock_generator_output_og_first_if); clock_generator.enable_clock(clock_generator_output_og_second_if); clock_generator.enable_output_mask(1U << clock_generator_output_og_second_if); #else if (hackrf_r9) { clock_generator.enable_clock(clock_generator_output_r9_if); clock_generator.enable_output_mask(1U << clock_generator_output_r9_if); } else { clock_generator.enable_clock(clock_generator_output_og_first_if); clock_generator.enable_output_mask(1U << clock_generator_output_og_first_if); clock_generator.enable_clock(clock_generator_output_og_second_if); clock_generator.enable_output_mask(1U << clock_generator_output_og_second_if); } #endif } void ClockManager::disable_if_clocks() { #ifdef PRALINE clock_generator.disable_output_mask(1U << clock_generator_output_og_first_if); clock_generator.disable_clock(clock_generator_output_og_first_if); clock_generator.disable_output_mask(1U << clock_generator_output_og_second_if); clock_generator.disable_clock(clock_generator_output_og_second_if); #else if (hackrf_r9) { clock_generator.disable_output_mask(1U << clock_generator_output_r9_if); clock_generator.disable_clock(clock_generator_output_r9_if); } else { clock_generator.disable_output_mask(1U << clock_generator_output_og_first_if); clock_generator.disable_clock(clock_generator_output_og_first_if); clock_generator.disable_output_mask(1U << clock_generator_output_og_second_if); clock_generator.disable_clock(clock_generator_output_og_second_if); } #endif } void ClockManager::set_sampling_frequency(const uint32_t frequency) { #ifdef PRALINE /* * PRALINE sample rate strategy: * 1. Maximize AFE rate to push Nyquist above MAX2831's 11.6 MHz LPF minimum * 2. Use FPGA decimation/interpolation to achieve desired output rate * 3. Ensure AFE rate is achievable by Si5351 (clean division from 800 MHz VCO) */ constexpr uint32_t MAX_AFE_RATE = 40000000; // Use 40 MHz per GSG reference constexpr uint8_t MAX_N = 5; _base_band_frequency = frequency; uint8_t n = 0; uint32_t afe_rate = frequency; // Find the largest n where AFE rate stays within limit // Start at n=0 and work up while (n < MAX_N) { uint32_t next_rate = afe_rate << 1; if (next_rate > MAX_AFE_RATE) break; afe_rate = next_rate; n++; } /* The TX gateware only implements interpolation factors x1..x16 * (tx_intrp 0..4). The rate search above can select n == 5 (x32) for very * low TX sample rates. If we kept afe_rate/CLK0/CLK1 at the x32 rate while * the FPGA only interpolated by x16, the TX datapath would be clocked at * twice the gateware's output rate, doubling the waveform speed. Cap the * AFE rate and _resampling_n to the x16 limit in TX so the clocks and the * interpolation setting stay aligned. */ if (radio::debug::get_cached_direction() == rf::Direction::Transmit) { constexpr uint8_t MAX_TX_N = 4; // x16, matches max tx_intrp if (n > MAX_TX_N) { n = MAX_TX_N; afe_rate = frequency << n; } } _resampling_n = n; radio::invalidate_spi_config(); // Configure Si5351 clocks using the correct AFE VCO // CLK0 always drives the AFE/MAX5864 clock. clock_generator.set_ms_frequency(0, afe_rate * 2, si5351_vco_afe_f, 1); /* Do not reset PLLA here. On PRALINE, CLK2/MCU_CLKIN is sourced from PLLA, * so a runtime PLLA reset can glitch the LPC43xx peripheral clock tree and * break SGPIO-driven RX apps such as ADSB/APRS. Updating the multisynths is * sufficient for sample-rate changes. */ if (radio::debug::get_cached_direction() == rf::Direction::Transmit) { /* * TX path: * Baseband generators such as AFSK still synthesize samples at their * legacy logical sample rates (for APRS this is 1.536MHz). On PRALINE, * the FPGA must interpolate those samples up to the active AFE rate. * * The TX datapath is clocked from CLK1/fpgaclk. Therefore CLK1 must * equal the desired complex sample rate at the DAC side. Driving CLK1 * at 2x the intended TX sample rate causes the entire APRS waveform to * run twice as fast, which matches the "energy present, undecodable" * symptom seen on HackRF One receivers. * * Gateware mapping from standard.py: * tx_intrp = 0 -> x1 * tx_intrp = 1 -> x2 * tx_intrp = 2 -> x4 * tx_intrp = 3 -> x8 * tx_intrp = 4 -> x16 */ if (fpga_get_mode() != FPGA_MODE_TX) { fpga_set_mode(FPGA_MODE_TX); } // TX gateware consumes complex samples at the rate presented on CLK1. clock_generator.set_ms_frequency(1, afe_rate, si5351_vco_afe_f, 0); uint8_t tx_interp = 0; uint32_t tx_rate = frequency; while ((tx_rate < afe_rate) && (tx_interp < 4)) { tx_rate <<= 1; tx_interp++; } fpga_tx_set_interpolation(tx_interp); fpga_tx_set_nco_enable(false); fpga_tx_set_phase_step(0); } // for RX mode else { // RX path keeps CLK1 at 2x AFE for receive timing / SGPIO alignment. clock_generator.set_ms_frequency(1, afe_rate * 2, si5351_vco_afe_f, 0); // === Stop FPGA processing and flush filters === fpga_debug_register_write(1, 0x00); // Disable FPGA filters (resets CIC accumulators) if (fpga_get_mode() != FPGA_MODE_RX) { fpga_set_mode(FPGA_MODE_RX); } // Set FPGA RX decimation register fpga_debug_register_write(FPGA_REG_DECIM, n); /* RX Mode: Register 3 is FPGA_REG_RX_DIGITAL_GAIN. * We shift up by (3 * n) to compensate for CIC bit-growth. */ uint8_t ds = (3 * n); ds += 2; fpga_debug_register_write(FPGA_REG_RX_DIGITAL_GAIN, ds); // Re-enable FPGA processing with clean state === fpga_debug_register_write(1, 0x01); } #else /* Codec clock is at sampling frequency, CPLD and SGPIO clocks are at * twice the frequency, and derived from the MS0 synth. So it's only * necessary to change the MS0 synth frequency, and ensure the output * is divided by two. */ if (hackrf_r9) { clock_generator.set_ms_frequency(clock_generator_output_r9_sgpio, frequency * 2, si5351_vco_f, 0); } else { clock_generator.set_ms_frequency(clock_generator_output_og_codec, frequency * 2, si5351_vco_f, 1); } #endif } void ClockManager::set_reference_ppb(const int32_t ppb) { /* NOTE: This adjustment only affects PLLA when it is derived from the 25MHz crystal. * It is assumed an external clock coming in to CLKIN/PLLB is sufficiently accurate as to not need adjustment. * TODO: Revisit the above policy. It may be good to allow adjustment of the external reference too. */ #ifdef PRALINE // On Praline, only apply if we aren't locked to a superior external 10MHz source // (Assuming you have a way to detect the 10MHz presence on Praline) if (reference.source == ReferenceSource::External) { return; } constexpr uint32_t pll_multiplier = si5351_pll_a_afe_800m.a; #else if (hackrf_r9 && reference.source != ReferenceSource::Xtal) { return; } constexpr uint32_t pll_multiplier = si5351_pll_xtal_25m.a; #endif constexpr uint32_t denominator = 1000000 / pll_multiplier; const uint32_t new_a = (ppb >= 0) ? pll_multiplier : (pll_multiplier - 1); const uint32_t new_b = (ppb >= 0) ? (ppb / 1000) : (denominator + (ppb / 1000)); const uint32_t new_c = (ppb == 0) ? 1 : denominator; const si5351::PLL pll{ .f_in = si5351_inputs.f_xtal, .a = new_a, .b = new_b, .c = new_c, }; #ifdef PRALINE clock_generator.write_pll_single_byte(0, pll); #else const auto pll_a_reg = pll.reg(0); clock_generator.write(pll_a_reg); #endif } void ClockManager::start_frequency_monitor_measurement(const cgu::CLK_SEL clk_sel) { // Measure a clock input for 480 cycles of the LPC43xx IRC. LPC_CGU->FREQ_MON = LPC_CGU_FREQ_MON_Type{ .RCNT = 480, .FCNT = 0, .MEAS = 0, .CLK_SEL = toUType(clk_sel), .RESERVED0 = 0}; LPC_CGU->FREQ_MON.MEAS = 1; } void ClockManager::wait_For_frequency_monitor_measurement_done() { // FREQ_MON mechanism fails to finish if there's no clock present on selected input?! #ifdef PRALINE // PRALINE FIX: Add timeout to prevent infinite hang uint32_t timeout = 100000; while (LPC_CGU->FREQ_MON.MEAS == 1 && timeout > 0) { timeout--; } #else while (LPC_CGU->FREQ_MON.MEAS == 1); #endif } uint32_t ClockManager::get_frequency_monitor_measurement_in_hertz() { // Measurement is only as accurate as the LPC43xx IRC oscillator, // which is +/- 1.5%. Measurement is for 480 IRC clcocks. Scale // the cycle count to get a value in Hertz. return LPC_CGU->FREQ_MON.FCNT * 25000; } void ClockManager::start_audio_pll() { #ifdef PRALINE // Control Block cgu::pll0audio::ctrl({ .pd = 1, // Start powered down .bypass = 0, // Use the PLL .directi = 0, // Enable N-divider .directo = 0, // Enable P-divider .clken = 0, // Disable output initially .frm = 0, // Normal mode .autoblock = 1, // Glitchless switching .pllfract_req = 1, // Integer, Disabled .sel_ext = 1, // Use GP_CLKIN (CLK2) .mod_pd = 0, // Modulator OFF .clk_sel = cgu::CLK_SEL::GP_CLKIN, }); /* * Audio PLL Configuration for 48 kHz audio with 256Fs MCLK * Target output: Fout = 12.288 MHz * * Formulas: * Fout = Fin × MSEL / (NSEL × PSEL) * FCO = 2 × Fin × MSEL / NSEL (must be 275-550 MHz) */ /* * ┌─────────────────────────────────────────────────────────────────┐ * │ 10 MHz INPUT (HackRF r9 compatible but interfere with fm band) │ * ├─────────────────────────────────────────────────────────────────┤ * │ MSEL=3072, NSEL=125, PSEL=20 │ * │ Fout = 10 × 3072 / (125 × 20) = 30720 / 2500 = 12.288 MHz ✓ │ * │ FCO = 2 × 10 × 3072 / 125 = 61440 / 125 = 491.52 MHz ✓ │ * │ │ * │ Encoded values: MDEC=8308, NDEC=45, PDEC=31 │ * │ CLK2 harmonics: 90, 100, 110 MHz (interfere with FM band!) │ * └─────────────────────────────────────────────────────────────────┘ */ /* // Math: (10 MHz * 3072) / (125 * 20) * 2 = 12.288MHz cgu::pll0audio::mdiv({.mdec = 8308UL}); // MSEL = 3072 cgu::pll0audio::np_div({ .pdec = 31, // PSEL = 20 for 10 MHz .ndec = 45 // NSEL = 125 for 10 MHz }); */ /* * ┌─────────────────────────────────────────────────────────────────┐ * │ 40 MHz INPUT (Recommended - avoids FM band harmonics) │ * ├─────────────────────────────────────────────────────────────────┤ * │ MSEL=768, NSEL=125, PSEL=20 │ * │ Fout = 40 × 768 / (125 × 20) = 30720 / 2500 = 12.288 MHz ✓ │ * │ FCO = 2 × 40 × 768 / 125 = 61440 / 125 = 491.52 MHz ✓ │ * │ │ * │ Encoded values: MDEC=30542, NDEC=45, PDEC=31 │ * │ CLK2 harmonics: 80, 120, 160 MHz (none in FM 88-108 MHz band) │ * └─────────────────────────────────────────────────────────────────┘ */ // 40 MHz input → 12.288 MHz output (same as HackRF OG) // Math: (40MHz * 768) / (125 * 20) * 2 = 12.288MHz cgu::pll0audio::mdiv({.mdec = 30542UL}); // MSEL = 768 cgu::pll0audio::np_div({.pdec = 31, .ndec = 45}); cgu::pll0audio::frac({.pllfract_ctrl = 0}); cgu::pll0audio::power_up(); // Lock and Routing (Keep as is) { uint32_t timeout = 100000; while (!cgu::pll0audio::is_locked() && timeout > 0) { timeout--; } } cgu::pll0audio::clock_enable(); set_base_audio_clock_divider(1); LPC_CGU->BASE_AUDIO_CLK.AUTOBLOCK = 1; LPC_CGU->BASE_AUDIO_CLK.CLK_SEL = toUType(cgu::CLK_SEL::IDIVD); #else cgu::pll0audio::ctrl({ .pd = 1, .bypass = 0, .directi = 0, .directo = 0, .clken = 0, .frm = 0, .autoblock = 1, .pllfract_req = 0, .sel_ext = 1, .mod_pd = 1, .clk_sel = cgu::CLK_SEL::GP_CLKIN, }); /* For 40MHz clock source, 48kHz audio rate, 256Fs MCLK: * Fout=12.288MHz, Fcco=491.52MHz * OG: PSEL=20, NSEL=125, MSEL=768 * PDEC=31, NDEC=45, MDEC=30542 * r9: PSEL=20, NSEL=125, MSEL=3072 * PDEC=31, NDEC=45, MDEC=8308 */ cgu::pll0audio::mdiv({ .mdec = hackrf_r9 ? 8308UL : 30542UL, }); cgu::pll0audio::np_div({ .pdec = 31, .ndec = 45, }); cgu::pll0audio::frac({ .pllfract_ctrl = 0, }); cgu::pll0audio::power_up(); while (!cgu::pll0audio::is_locked()); cgu::pll0audio::clock_enable(); set_base_audio_clock_divider(1); LPC_CGU->BASE_AUDIO_CLK.AUTOBLOCK = 1; LPC_CGU->BASE_AUDIO_CLK.CLK_SEL = toUType(cgu::CLK_SEL::IDIVD); #endif } void ClockManager::set_base_audio_clock_divider(const size_t divisor) { LPC_CGU->IDIVD_CTRL.word = (0 << 0) | ((divisor - 1) << 2) | (1 << 11) | (toUType(cgu::CLK_SEL::PLL0AUDIO) << 24); } void ClockManager::stop_audio_pll() { #ifdef PRALINE /* PRALINE: Gracefully switch audio peripherals away from the PLL branch */ LPC_CGU->BASE_AUDIO_CLK.PD = 1; // Power down the branch first LPC_CGU->BASE_AUDIO_CLK.CLK_SEL = toUType(cgu::CLK_SEL::IRC); // Reset to safe IRC source #endif cgu::pll0audio::clock_disable(); cgu::pll0audio::power_down(); #ifdef PRALINE /* PRALINE: Add a safety timeout to the unlock check to prevent potential hangs */ uint32_t timeout = 100000; while (cgu::pll0audio::is_locked() && timeout > 0) { timeout--; } #else while (cgu::pll0audio::is_locked()); #endif } void ClockManager::enable_clock_output(bool enable) { #ifdef PRALINE auto clkout_select = clock_generator_output_og_clkout; if (enable) { clock_generator.enable_output(clkout_select); if (portapack::persistent_memory::clkout_freq() < 1000) { clock_generator.set_ms_frequency(clkout_select, portapack::persistent_memory::clkout_freq() * 128000, si5351_vco_f, 7); } else { clock_generator.set_ms_frequency(clkout_select, portapack::persistent_memory::clkout_freq() * 1000, si5351_vco_f, 0); } auto si5351_clock_control_common = si5351a_clock_control_common; const auto ref_pll = get_si5351a_reference_clock_generator_pll(reference.source); clock_generator.set_clock_control(clkout_select, si5351_clock_control_common[clkout_select].ms_src(ref_pll).clk_pdn(ClockControl::ClockPowerDown::Power_On)); } else { clock_generator.disable_output(clkout_select); clock_generator.set_clock_control(clkout_select, ClockControl::power_off()); } #else if (hackrf_r9) { gpio_r9_clkout_en.output(); gpio_r9_clkout_en.write(enable); // NOTE: RETURNING HERE IF HACKRF_R9 TO PREVENT CLK2 FROM BEING DISABLED OR FREQ MODIFIED SINCE CLK2 ON R9 IS // USED FOR BOTH CLKOUT AND FOR THE MCU_CLOCK (== GP_CLKIN) WHICH OTHER LP43XX CLOCKS CURRENTLY RELY ON. // FUTURE TBD: REMOVE OTHER LP43XX CLOCK DEPENDENCIES ON GP_CLKIN, THEN DELETE THE return LINE BELOW TO ALLOW // CLKOUT FREQ CHANGES ON R9 BOARDS. return; } auto clkout_select = hackrf_r9 ? clock_generator_output_r9_clkout : clock_generator_output_og_clkout; if (enable) { clock_generator.enable_output(clkout_select); if (portapack::persistent_memory::clkout_freq() < 1000) { clock_generator.set_ms_frequency(clkout_select, portapack::persistent_memory::clkout_freq() * 128000, si5351_vco_f, 7); } else { clock_generator.set_ms_frequency(clkout_select, portapack::persistent_memory::clkout_freq() * 1000, si5351_vco_f, 0); } auto si5351_clock_control_common = hackrf_r9 ? si5351a_clock_control_common : si5351c_clock_control_common; const auto ref_pll = hackrf_r9 ? ClockControl::MultiSynthSource::PLLA : get_si5351c_reference_clock_generator_pll(reference.source); clock_generator.set_clock_control(clkout_select, si5351_clock_control_common[clkout_select].ms_src(ref_pll).clk_pdn(ClockControl::ClockPowerDown::Power_On)); } else { clock_generator.disable_output(clkout_select); clock_generator.set_clock_control(clkout_select, ClockControl::power_off()); } #endif } #ifdef PRALINE void ClockManager::set_p1_control(P1_Function func) { // Truth table based on P1_Control.csv (L=setInactive, H=setActive) switch (func) { case P1_Function::TriggerIn: gpio_control::p1_ctrl2.setInactive(); gpio_control::p1_ctrl1.setInactive(); gpio_control::p1_ctrl0.setInactive(); break; case P1_Function::AuxClk1: gpio_control::p1_ctrl2.setInactive(); gpio_control::p1_ctrl1.setInactive(); gpio_control::p1_ctrl0.setActive(); break; case P1_Function::ClkIn: gpio_control::p1_ctrl2.setInactive(); gpio_control::p1_ctrl1.setActive(); gpio_control::p1_ctrl0.setInactive(); break; case P1_Function::TriggerOut: gpio_control::p1_ctrl2.setInactive(); gpio_control::p1_ctrl1.setActive(); gpio_control::p1_ctrl0.setActive(); break; case P1_Function::P22_ClkIn: gpio_control::p1_ctrl2.setActive(); gpio_control::p1_ctrl1.setInactive(); gpio_control::p1_ctrl0.setInactive(); break; case P1_Function::P2_5: gpio_control::p1_ctrl2.setActive(); gpio_control::p1_ctrl1.setInactive(); gpio_control::p1_ctrl0.setActive(); break; case P1_Function::NotConnected: gpio_control::p1_ctrl2.setActive(); gpio_control::p1_ctrl1.setActive(); gpio_control::p1_ctrl0.setInactive(); break; case P1_Function::AuxClk2: gpio_control::p1_ctrl2.setActive(); gpio_control::p1_ctrl1.setActive(); gpio_control::p1_ctrl0.setActive(); break; } } void ClockManager::set_p2_control(P2_Function func) { // Ensure all P2 control pins are configured as outputs // Truth table based on P2_Control.csv (L=setInactive, H=setActive) switch (func) { case P2_Function::Clk3: // CTRL0 is 'X' (don't care) according to CSV, we default it to Low (setInactive) gpio_control::p2_ctrl1.setInactive(); gpio_control::p2_ctrl0.setInactive(); break; case P2_Function::TriggerIn: gpio_control::p2_ctrl1.setActive(); gpio_control::p2_ctrl0.setInactive(); break; case P2_Function::TriggerOut: gpio_control::p2_ctrl1.setActive(); gpio_control::p2_ctrl0.setActive(); break; } } #endif