Faster usb serial file download (#1674)

* Made file read much faster via USB serial
* Remove old code

firmware/application/apps/ble_rx_app.cpp

@@ -426,6 +426,7 @@ BLERxView::BLERxView(NavigationView& nav)
                   &options_sort,
                   &label_found,
                   &text_found_count,
+                  &check_serial_log,
                   &button_filter,
                   &button_save_list,
                   &button_clear_list,
@@ -436,7 +437,15 @@ BLERxView::BLERxView(NavigationView& nav)
         nav_.push<BleRecentEntryDetailView>(entry);
     };
 
-    usb_serial_thread = std::make_unique<UsbSerialThread>();
+    check_serial_log.on_select = [this](Checkbox&, bool v) {
+        serial_logging = v;
+        if (v) {
+            usb_serial_thread = std::make_unique<UsbSerialThread>();
+        } else {
+            usb_serial_thread.reset();
+        }
+    };
+    check_serial_log.set_value(serial_logging);
 
     ensure_directory(find_packet_path);
     ensure_directory(log_packets_path);
@@ -456,8 +465,6 @@ BLERxView::BLERxView(NavigationView& nav)
 
     logger = std::make_unique<BLELogger>();
 
-    check_log.set_value(logging);
-
     check_log.on_select = [this](Checkbox&, bool v) {
         str_log = "";
         logging = v;
@@ -468,6 +475,7 @@ BLERxView::BLERxView(NavigationView& nav)
                 "/BLELOG_" +
                 to_string_timestamp(rtc_time::now()) + ".TXT");
     };
+    check_log.set_value(logging);
 
     button_save_list.on_select = [this, &nav](const ui::Button&) {
         listFileBuffer = "";
@@ -723,8 +731,10 @@ void BLERxView::on_data(BlePacketData* packet) {
         logger->log_raw_data(str_console + "\r\n");
     }
 
-    usb_serial_thread->serial_str = str_console + "\r\n";
-    usb_serial_thread->str_ready = true;
+    if (serial_logging) {
+        usb_serial_thread->serial_str = str_console + "\r\n";
+        usb_serial_thread->str_ready = true;
+    }
     str_console = "";
 
     if (!searchList.empty()) {

firmware/application/apps/ble_rx_app.hpp

@@ -215,6 +215,7 @@ class BLERxView : public View {
     uint8_t sort_index{0};
     std::string filter{};
     bool logging{false};
+    bool serial_logging{false};
 
     bool name_enable{true};
     app_settings::SettingsManager settings_{
@@ -225,6 +226,8 @@ class BLERxView : public View {
             {"sort_index"sv, &sort_index},
             {"filter"sv, &filter},
             {"log"sv, &logging},
+            // disabled to always start without USB serial activated until we can make it non blocking if not connected
+            // {"serial_log"sv, &serial_logging},
             {"name"sv, &name_enable},
         }};
 
@@ -320,6 +323,12 @@ class BLERxView : public View {
         {11 * 8, 3 * 16, 20 * 8, 16},
         "0/0"};
 
+    Checkbox check_serial_log{
+        {17 * 8, 3 * 16 - 2},
+        7,
+        "USB Log",
+        true};
+
     Console console{
         {0, 4 * 16, 240, 240}};
 

firmware/application/apps/ui_debug.cpp

@@ -176,12 +176,15 @@ void RegistersWidget::paint(Painter& painter) {
 
 void RegistersWidget::draw_legend(const Coord left, Painter& painter) {
     const auto pos = screen_pos();
+    const std::string spaces(config.legend_length(), ' ');
+
+    for (uint32_t i = 0; i < config.registers_per_page; i += config.registers_per_row()) {
+        uint32_t r = page_number * config.registers_per_page + i;
 
-    for (uint32_t i = 0; i < config.registers_count; i += config.registers_per_row()) {
         const Point offset{
             left, static_cast<int>((i / config.registers_per_row()) * row_height)};
 
-        const auto text = to_string_hex(i, config.legend_length());
+        const auto text = (r >= config.registers_count) ? spaces : to_string_hex(r, config.legend_length());
         painter.draw_string(
             pos + offset,
             style().invert(),
@@ -193,15 +196,16 @@ void RegistersWidget::draw_values(
     const Coord left,
     Painter& painter) {
     const auto pos = screen_pos();
+    const std::string spaces(config.value_length(), ' ');
+
+    for (uint32_t i = 0; i < config.registers_per_page; i++) {
+        uint32_t r = page_number * config.registers_per_page + i;
 
-    for (uint32_t i = 0; i < config.registers_count; i++) {
         const Point offset = {
             static_cast<int>(left + config.legend_width() + 8 + (i % config.registers_per_row()) * (config.value_width() + 8)),
             static_cast<int>((i / config.registers_per_row()) * row_height)};
 
-        const auto value = reg_read(i);
-
-        const auto text = to_string_hex(value, config.value_length());
+        const auto text = (r >= config.registers_count) ? spaces : to_string_hex(reg_read(r), config.value_length());
         painter.draw_string(
             pos + offset,
             style(),
@@ -213,7 +217,7 @@ uint32_t RegistersWidget::reg_read(const uint32_t register_number) {
     if (register_number < config.registers_count) {
         switch (config.chip_type) {
             case CT_PMEM:
-                return portapack::persistent_memory::pmem_data_word((page_number * config.registers_count + register_number) / 4) >> (register_number % 4 * 8);
+                return portapack::persistent_memory::pmem_data_word(register_number / 4) >> (register_number % 4 * 8);
             case CT_RFFC5072:
                 return radio::debug::first_if::register_read(register_number);
             case CT_MAX283X:
@@ -272,6 +276,7 @@ RegistersView::RegistersView(
     button_done.on_select = [&nav](Button&) { nav.pop(); };
 
     registers_widget.set_parent_rect({0, 48, 240, 192});
+    registers_widget.set_page(0);
 
     text_title.set_parent_rect({(240 - static_cast<int>(title.size()) * 8) / 2, 16,
                                 static_cast<int>(title.size()) * 8, 16});
@@ -296,6 +301,13 @@ void RegistersView::focus() {
     button_done.focus();
 }
 
+bool RegistersView::on_encoder(const EncoderEvent delta) {
+    registers_widget.set_page(std::max(0ul, std::min(registers_widget.page_count() - 1, registers_widget.page() + delta)));
+    registers_widget.update();
+
+    return true;
+}
+
 /* ControlsSwitchesWidget ************************************************/
 
 void ControlsSwitchesWidget::on_show() {
@@ -429,10 +441,10 @@ DebugPeripheralsMenuView::DebugPeripheralsMenuView(NavigationView& nav) {
     const char* max283x = hackrf_r9 ? "MAX2839" : "MAX2837";
     const char* si5351x = hackrf_r9 ? "Si5351A" : "Si5351C";
     add_items({
-        {"RFFC5072", ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav]() { nav.push<RegistersView>("RFFC5072", RegistersWidgetConfig{CT_RFFC5072, 31, 16}); }},
-        {max283x, ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav, max283x]() { nav.push<RegistersView>(max283x, RegistersWidgetConfig{CT_MAX283X, 32, 10}); }},
-        {si5351x, ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav, si5351x]() { nav.push<RegistersView>(si5351x, RegistersWidgetConfig{CT_SI5351, 96, 8}); }},
-        {audio::debug::codec_name(), ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav]() { nav.push<RegistersView>(audio::debug::codec_name(), RegistersWidgetConfig{CT_AUDIO, audio::debug::reg_count(), audio::debug::reg_bits()}); }},
+        {"RFFC5072", ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav]() { nav.push<RegistersView>("RFFC5072", RegistersWidgetConfig{CT_RFFC5072, 31, 31, 16}); }},
+        {max283x, ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav, max283x]() { nav.push<RegistersView>(max283x, RegistersWidgetConfig{CT_MAX283X, 32, 32, 10}); }},
+        {si5351x, ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav, si5351x]() { nav.push<RegistersView>(si5351x, RegistersWidgetConfig{CT_SI5351, 188, 96, 8}); }},
+        {audio::debug::codec_name(), ui::Color::dark_cyan(), &bitmap_icon_peripherals_details, [&nav]() { nav.push<RegistersView>(audio::debug::codec_name(), RegistersWidgetConfig{CT_AUDIO, audio::debug::reg_count(), audio::debug::reg_count(), audio::debug::reg_bits()}); }},
     });
     set_max_rows(2);  // allow wider buttons
 }
@@ -504,8 +516,8 @@ void DebugMemoryDumpView::focus() {
 /* DebugPmemView *********************************************************/
 
 DebugPmemView::DebugPmemView(NavigationView& nav)
-    : registers_widget(RegistersWidgetConfig{CT_PMEM, page_size, 8}) {
-    add_children({&text_page, &registers_widget, &text_checksum, &text_checksum2, &button_ok});
+    : registers_widget(RegistersWidgetConfig{CT_PMEM, PMEM_SIZE_BYTES, page_size, 8}) {
+    add_children({&registers_widget, &text_checksum, &text_checksum2, &button_ok});
 
     registers_widget.set_parent_rect({0, 32, 240, 192});
 
@@ -532,7 +544,6 @@ void DebugPmemView::focus() {
 }
 
 void DebugPmemView::update() {
-    text_page.set(to_string_hex(registers_widget.page() * page_size, 2) + "+");
     registers_widget.update();
 }
 

firmware/application/apps/ui_debug.hpp

@@ -142,6 +142,7 @@ typedef enum {
 struct RegistersWidgetConfig {
     chip_type_t chip_type;
     uint32_t registers_count;
+    uint32_t registers_per_page;
     uint32_t register_bits;
 
     constexpr size_t legend_length() const {
@@ -194,6 +195,7 @@ class RegistersWidget : public Widget {
 
     void set_page(int32_t value) { page_number = value; }
     uint32_t page(void) { return page_number; }
+    uint32_t page_count(void) { return (config.registers_count + config.registers_per_page - 1) / config.registers_per_page; }
 
    private:
     const RegistersWidgetConfig config;
@@ -208,8 +210,8 @@ class RegistersWidget : public Widget {
 class RegistersView : public View {
    public:
     RegistersView(NavigationView& nav, const std::string& title, RegistersWidgetConfig&& config);
-
-    void focus();
+    void focus() override;
+    bool on_encoder(const EncoderEvent delta) override;
 
    private:
     Text text_title{};
@@ -364,8 +366,6 @@ class DebugPmemView : public View {
     static constexpr uint8_t page_size{96};  // Must be multiply of 4 otherwise bit shifting for register view wont work properly
     static constexpr uint8_t page_count{(portapack::memory::map::backup_ram.size() + page_size - 1) / page_size};
 
-    Text text_page{{16, 16, 208, 16}};
-
     RegistersWidget registers_widget;
 
     Text text_checksum{{16, 232, 208, 16}};

firmware/application/apps/ui_settings.cpp

@@ -133,7 +133,6 @@ SetRadioView::SetRadioView(
         &check_clkout,
         &field_clkout_freq,
         &labels_clkout_khz,
-        &value_freq_step,
         &labels_bias,
         &check_bias,
         &disable_external_tcxo,  // TODO: always show?
@@ -185,29 +184,20 @@ SetRadioView::SetRadioView(
         send_system_refresh();
     };
 
-    field_clkout_freq.set_value(pmem::clkout_freq());
-    value_freq_step.set_style(&Styles::light_grey);
+    // Disallow CLKOUT freq change on hackrf_r9 due to dependencies on GP_CLKIN (same Si5351A clock);
+    // see comments in ClockManager::enable_clock_output()
+    if (hackrf_r9) {
+        if (pmem::clkout_freq() != 10000)
+            pmem::set_clkout_freq(10000);
+        field_clkout_freq.set_focusable(false);
+    }
 
-    field_clkout_freq.on_select = [this](NumberField&) {
-        freq_step_khz++;
-        if (freq_step_khz > 3) {
-            freq_step_khz = 0;
-        }
-        switch (freq_step_khz) {
-            case 0:
-                value_freq_step.set("   |");
-                break;
-            case 1:
-                value_freq_step.set("  | ");
-                break;
-            case 2:
-                value_freq_step.set(" |  ");
-                break;
-            case 3:
-                value_freq_step.set("|   ");
-                break;
-        }
-        field_clkout_freq.set_step(pow(10, freq_step_khz));
+    field_clkout_freq.set_value(pmem::clkout_freq());
+    field_clkout_freq.on_change = [this](SymField&) {
+        if (field_clkout_freq.to_integer() < 10)
+            field_clkout_freq.set_value(10);
+        if (field_clkout_freq.to_integer() > 60000)
+            field_clkout_freq.set_value(60000);
     };
 
     check_bias.set_value(get_antenna_bias());
@@ -248,7 +238,7 @@ void SetRadioView::form_init(const SetFrequencyCorrectionModel& model) {
 SetFrequencyCorrectionModel SetRadioView::form_collect() {
     return {
         .ppm = static_cast<int8_t>(field_ppm.value()),
-        .freq = static_cast<uint32_t>(field_clkout_freq.value()),
+        .freq = static_cast<uint32_t>(field_clkout_freq.to_integer()),
     };
 }
 

firmware/application/apps/ui_settings.hpp

@@ -163,20 +163,14 @@ class SetRadioView : public View {
         13,
         "Enable CLKOUT"};
 
-    NumberField field_clkout_freq{
+    SymField field_clkout_freq{
         {20 * 8, 6 * 16},
         5,
-        {10, 60000},
-        1000,
-        ' '};
+        SymField::Type::Dec};
 
     Labels labels_clkout_khz{
         {{26 * 8, 6 * 16}, "kHz", Color::light_grey()}};
 
-    Text value_freq_step{
-        {21 * 8, (7 * 16), 4 * 8, 16},
-        "|   "};
-
     Labels labels_bias{
         {{4 * 8 + 4, 8 * 16}, "CAUTION: Ensure that all", Color::red()},
         {{5 * 8 + 0, 9 * 16}, "devices attached to the", Color::red()},

firmware/application/clock_manager.cpp

@@ -561,26 +561,32 @@ void ClockManager::stop_audio_pll() {
 }
 
 void ClockManager::enable_clock_output(bool enable) {
-    if (enable) {
-        clock_generator.enable_output(clock_generator_output_og_clkout);
-        if (portapack::persistent_memory::clkout_freq() < 1000) {
-            clock_generator.set_ms_frequency(clock_generator_output_og_clkout, portapack::persistent_memory::clkout_freq() * 128000, si5351_vco_f, 7);
-        } else {
-            clock_generator.set_ms_frequency(clock_generator_output_og_clkout, portapack::persistent_memory::clkout_freq() * 1000, si5351_vco_f, 0);
-        }
-    } else {
-        clock_generator.disable_output(clock_generator_output_og_clkout);
+    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 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);
+    auto clkout_select = hackrf_r9 ? clock_generator_output_r9_clkout : clock_generator_output_og_clkout;
 
-    if (enable)
-        clock_generator.set_clock_control(clock_generator_output_og_clkout, si5351_clock_control_common[clock_generator_output_og_clkout].ms_src(ref_pll).clk_pdn(ClockControl::ClockPowerDown::Power_On));
-    else
-        clock_generator.set_clock_control(clock_generator_output_og_clkout, ClockControl::power_off());
+    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());
+    }
 }

firmware/application/ui_navigation.cpp

@@ -173,6 +173,9 @@ SystemStatusView::SystemStatusView(
         pmem::load_persistent_settings_from_file();
     }
 
+    // configure CLKOUT per pmem setting
+    portapack::clock_manager.enable_clock_output(pmem::clkout_enabled());
+
     // force apply of selected sdcard speed override at UI startup
     pmem::set_config_sdcard_high_speed_io(pmem::config_sdcard_high_speed_io(), false);
 

firmware/application/usb_serial_shell.cpp

@@ -418,21 +418,18 @@ static void cmd_sd_read(BaseSequentialStream* chp, int argc, char* argv[]) {
 
     int size = (int)strtol(argv[0], NULL, 10);
 
-    uint8_t buffer[16];
+    uint8_t buffer[62];
 
     do {
-        File::Size bytes_to_read = size > 16 ? 16 : size;
+        File::Size bytes_to_read = size > 62 ? 62 : size;
         auto bytes_read = shell_file->read(buffer, bytes_to_read);
         if (bytes_read.is_error()) {
             chprintf(chp, "error %d\r\n", bytes_read.error());
             return;
         }
-
-        for (size_t i = 0; i < bytes_read.value(); i++)
-            chprintf(chp, "%02X", buffer[i]);
-
-        chprintf(chp, "\r\n");
-
+        std::string res = to_string_hex_array(buffer, bytes_read.value());
+        res += "\r\n";
+        fillOBuffer(&((SerialUSBDriver*)chp)->oqueue, (const uint8_t*)res.c_str(), res.size());
         if (bytes_to_read != bytes_read.value())
             return;
 

firmware/common/hackrf_hal.hpp

@@ -68,6 +68,7 @@ constexpr size_t clock_generator_output_og_mcu_clkin = 7;
 
 constexpr size_t clock_generator_output_r9_if = 0;
 constexpr size_t clock_generator_output_r9_sgpio = 1;
+constexpr size_t clock_generator_output_r9_clkout = 2;
 constexpr size_t clock_generator_output_r9_mcu_clkin = 2;
 
 /* ADC0 */

firmware/common/portapack_persistent_memory.cpp

@@ -284,11 +284,11 @@ struct data_t {
 
 struct backup_ram_t {
    private:
-    volatile uint32_t regfile[63];
+    volatile uint32_t regfile[PMEM_SIZE_WORDS - 1];
     volatile uint32_t check_value;
 
     static void copy(const backup_ram_t& src, backup_ram_t& dst) {
-        for (size_t i = 0; i < 63; i++) {
+        for (size_t i = 0; i < PMEM_SIZE_WORDS - 1; i++) {
             dst.regfile[i] = src.regfile[i];
         }
         dst.check_value = src.check_value;
@@ -297,7 +297,7 @@ struct backup_ram_t {
     static void copy_from_data_t(const data_t& src, backup_ram_t& dst) {
         const uint32_t* const src_words = (uint32_t*)&src;
         const size_t word_count = (sizeof(data_t) + 3) / 4;
-        for (size_t i = 0; i < 63; i++) {
+        for (size_t i = 0; i < PMEM_SIZE_WORDS - 1; i++) {
             if (i < word_count) {
                 dst.regfile[i] = src_words[i];
             } else {
@@ -308,7 +308,7 @@ struct backup_ram_t {
 
     uint32_t compute_check_value() {
         CRC<32> crc{0x04c11db7, 0xffffffff, 0xffffffff};
-        for (size_t i = 0; i < 63; i++) {
+        for (size_t i = 0; i < PMEM_SIZE_WORDS - 1; i++) {
             const auto word = regfile[i];
             crc.process_byte((word >> 0) & 0xff);
             crc.process_byte((word >> 8) & 0xff);

firmware/common/portapack_persistent_memory.hpp

@@ -39,6 +39,9 @@
 // persistant memory from/to sdcard flag file
 #define PMEM_SETTING_FILE u"/SETTINGS/pmem_settings"
 
+#define PMEM_SIZE_BYTES 256  // total amount of pmem space in bytes, including checksum
+#define PMEM_SIZE_WORDS (PMEM_SIZE_BYTES / 4)
+
 using namespace modems;
 using namespace serializer;