Update docker file (#719)

Pin base image ubuntu LTS version. add installation python3 with python3-yaml package. create python link in PATH for build hackrf dependency,

.github/workflows/past_version.txt

@@ -1 +1 @@
-v1.5.1
+v1.5.3

.github/workflows/version.txt

@@ -1 +1 @@
-v1.5.3
+v1.5.4

README.md

@@ -1,6 +1,6 @@
 # PortaPack Mayhem
 
-[![Build Status](https://travis-ci.com/eried/portapack-mayhem.svg?branch=master)](https://travis-ci.com/eried/portapack-mayhem) [![CodeScene Code Health](https://codescene.io/projects/8381/status-badges/code-health)](https://codescene.io/projects/8381) [![GitHub All Releases](https://img.shields.io/github/downloads/eried/portapack-mayhem/total)](https://github.com/eried/portapack-mayhem/releases) [![GitHub Releases](https://img.shields.io/github/downloads/eried/portapack-mayhem/latest/total)](https://github.com/eried/portapack-mayhem/releases/latest) [![Docker Hub Pulls](https://img.shields.io/docker/pulls/eried/portapack.svg)](https://hub.docker.com/r/eried/portapack) [![Discord Chat](https://img.shields.io/discord/719669764804444213.svg)](https://discord.gg/tuwVMv3)  [![Check bounties!](https://img.shields.io/bountysource/team/portapack-mayhem/activity?color=%2333ccff&label=bountysource%20%28USD%29&style=plastic)](https://www.bountysource.com/teams/portapack-mayhem/issues)
+[![Build Status](https://travis-ci.com/eried/portapack-mayhem.svg?branch=master)](https://travis-ci.com/eried/portapack-mayhem) [![Nightly Release](https://github.com/eried/portapack-mayhem/actions/workflows/create_nightly_release.yml/badge.svg?branch=next)](https://github.com/eried/portapack-mayhem/actions/workflows/create_nightly_release.yml) [![CodeScene Code Health](https://codescene.io/projects/8381/status-badges/code-health)](https://codescene.io/projects/8381) [![GitHub All Releases](https://img.shields.io/github/downloads/eried/portapack-mayhem/total)](https://github.com/eried/portapack-mayhem/releases) [![GitHub Releases](https://img.shields.io/github/downloads/eried/portapack-mayhem/latest/total)](https://github.com/eried/portapack-mayhem/releases/latest) [![Docker Hub Pulls](https://img.shields.io/docker/pulls/eried/portapack.svg)](https://hub.docker.com/r/eried/portapack) [![Discord Chat](https://img.shields.io/discord/719669764804444213.svg)](https://discord.gg/tuwVMv3)  [![Check bounties!](https://img.shields.io/bountysource/team/portapack-mayhem/activity?color=%2333ccff&label=bountysource%20%28USD%29&style=plastic)](https://www.bountysource.com/teams/portapack-mayhem/issues)
 
 This is a fork of the [Havoc](https://github.com/furrtek/portapack-havoc/) firmware, which itself was a fork of the [PortaPack](https://github.com/sharebrained/portapack-hackrf) firmware, an add-on for the [HackRF](http://greatscottgadgets.com/hackrf/). A fork is a derivate, in this case one that has extra features and fixes when compared to the older versions.
 

dockerfile

@@ -1,6 +1,6 @@
 #Download base image.
-#The ubuntu:latest tag points to the "latest LTS"
-FROM ubuntu:latest
+#The ubuntu:20.04 tag points to the "20.04 LTS"
+FROM ubuntu:20.04
 
 #Set location to download ARM toolkit from.
 # This will need to be changed over time or replaced with a static link to the latest release.
@@ -14,16 +14,18 @@ COPY ./ /havocsrc
 
 #Fetch dependencies from APT
 RUN apt-get update && \
-	apt-get install -y tar wget dfu-util cmake python bzip2 curl && \
-	apt-get -qy autoremove
+        apt-get install -y tar wget dfu-util cmake python bzip2 curl python3 python3-yaml && \
+        apt-get -qy autoremove
 
 #Install current pip from PyPa
 RUN curl https://bootstrap.pypa.io/pip/3.4/get-pip.py -o get-pip.py && \
-	python get-pip.py
+        python get-pip.py
 
 #Fetch additional dependencies from Python 2.x pip
 RUN pip install pyyaml
-RUN ln -s /usr/bin/python3 /usr/bin/python && \
+RUN rm -rf /usr/bin/python && \
+    rm -rf /usr/bin/pip && \
+    ln -s /usr/bin/python3 /usr/bin/python && \
     ln -s /usr/bin/pip3 /usr/bin/pip
 
 ENV LANG C.UTF-8
@@ -32,9 +34,9 @@ ENV LC_ALL C.UTF-8
 #Grab the GNU ARM toolchain from arm.com
 #Then extract contents to /opt/build/armbin/
 RUN mkdir /opt/build && cd /opt/build && \
-	wget -O gcc-arm-none-eabi $ARMBINURL && \
-	mkdir armbin && \
-	tar --strip=1 -xjvf gcc-arm-none-eabi -C armbin
+        wget -O gcc-arm-none-eabi $ARMBINURL && \
+        mkdir armbin && \
+        tar --strip=1 -xjvf gcc-arm-none-eabi -C armbin
     
 #Set environment variable so compiler knows where the toolchain lives
 ENV PATH=$PATH:/opt/build/armbin/bin
@@ -43,3 +45,4 @@ CMD cd /havocsrc && \
     mkdir build && cd build && \ 
     cmake .. && make firmware && \
     cp /portapack-havoc/firmware/portapack-h1-havoc.bin /havocbin
+

firmware/application/CMakeLists.txt

@@ -267,6 +267,7 @@ set(CPPSRC
 	apps/lge_app.cpp
 	apps/pocsag_app.cpp
 	apps/replay_app.cpp
+	apps/ui_playlist.cpp
 	apps/gps_sim_app.cpp
 	apps/soundboard_app.cpp
 	apps/tpms_app.cpp

firmware/application/apps/ais_app.cpp

@@ -76,12 +76,18 @@ static std::string mid(
 	mid_code = to_string_dec_uint(mmsi, 9, ' ').substr(0, 3);
 	return_code = db.retrieve_mid_record(&mid_record, mid_code);
 	switch(return_code) {
-		case DATABASE_RECORD_FOUND: 	return mid_record.country;	
+		case DATABASE_RECORD_FOUND: 	return mid_record.country;
 		case DATABASE_NOT_FOUND: 	return "No mids.db file";
 		default:			return "";
 	}
 }
 
+static std::string text(const std::string &text) {
+	size_t end = text.find_last_not_of("@");
+    return (end == std::string::npos) ? "" : text.substr(0, end + 1);
+
+}
+
 static std::string navigational_status(const unsigned int value) {
 	switch(value) {
 		case 0: return "under way w/engine";
@@ -164,7 +170,7 @@ void AISLogger::on_packet(const ais::Packet& packet) {
 	}
 
 	log_file.write_entry(packet.received_at(), entry);
-}	
+}
 
 void AISRecentEntry::update(const ais::Packet& packet) {
 	received_count++;
@@ -195,6 +201,15 @@ void AISRecentEntry::update(const ais::Packet& packet) {
 		destination = packet.text(302, 20);
 		break;
 
+	case 18:
+	    last_position.timestamp = packet.received_at();
+		last_position.speed_over_ground = packet.read(46, 10);
+		last_position.latitude = packet.latitude(85);
+		last_position.longitude = packet.longitude(57);
+		last_position.course_over_ground = packet.read(112, 12);
+		last_position.true_heading = packet.read(124, 9);
+	    break;
+
 	case 21:
 		name = packet.text(43, 20);
 		last_position.timestamp = packet.received_at();
@@ -202,6 +217,23 @@ void AISRecentEntry::update(const ais::Packet& packet) {
 		last_position.longitude = packet.longitude(164);
 		break;
 
+	case 24:
+		switch (packet.read(38, 2))
+		{
+		case 0:
+			name = packet.text(40, 20);
+			break;
+
+		case 1:
+			call_sign = packet.text(90, 7);
+			break;
+
+		default:
+			break;
+		}
+
+		break;
+
 	default:
 		break;
 	}
@@ -218,9 +250,9 @@ void RecentEntriesTable<AISRecentEntries>::draw(
 ) {
 	std::string line = ais::format::mmsi(entry.mmsi) + " ";
 	if( !entry.name.empty() ) {
-		line += entry.name;
+		line += ais::format::text(entry.name);
 	} else {
-		line += entry.call_sign;
+		line += ais::format::text(entry.call_sign);
 	}
 
 	line.resize(target_rect.width() / 8, ' ');
@@ -241,7 +273,7 @@ AISRecentEntryDetailView::AISRecentEntryDetailView(NavigationView& nav) {
 
 	button_see_map.on_select = [this, &nav](Button&) {
 		geomap_view = nav.push<GeoMapView>(
-			entry_.name,
+			ais::format::text(entry_.name),
 			0,
 			GeoPos::alt_unit::METERS,
 			ais::format::latlon_float(entry_.last_position.latitude.normalized()),
@@ -252,7 +284,7 @@ AISRecentEntryDetailView::AISRecentEntryDetailView(NavigationView& nav) {
 			});
 			send_updates = true;
 
-		
+
 	};
 }
 
@@ -262,7 +294,7 @@ AISRecentEntryDetailView::AISRecentEntryDetailView(const AISRecentEntryDetailVie
     (void)Entry;
 }
 
-AISRecentEntryDetailView & AISRecentEntryDetailView::operator=(const AISRecentEntryDetailView&Entry) 
+AISRecentEntryDetailView & AISRecentEntryDetailView::operator=(const AISRecentEntryDetailView&Entry)
 {
     (void)Entry;
     return *this;
@@ -302,9 +334,9 @@ void AISRecentEntryDetailView::paint(Painter& painter) {
 
 	field_rect = draw_field(painter, field_rect, s, "MMSI", ais::format::mmsi(entry_.mmsi));
 	field_rect = draw_field(painter, field_rect, s, "Ctry", ais::format::mid(entry_.mmsi));
-	field_rect = draw_field(painter, field_rect, s, "Name", entry_.name);
-	field_rect = draw_field(painter, field_rect, s, "Call", entry_.call_sign);
-	field_rect = draw_field(painter, field_rect, s, "Dest", entry_.destination);
+	field_rect = draw_field(painter, field_rect, s, "Name", ais::format::text(entry_.name));
+	field_rect = draw_field(painter, field_rect, s, "Call", ais::format::text(entry_.call_sign));
+	field_rect = draw_field(painter, field_rect, s, "Dest", ais::format::text(entry_.destination));
 	field_rect = draw_field(painter, field_rect, s, "Last", to_string_datetime(entry_.last_position.timestamp));
 	field_rect = draw_field(painter, field_rect, s, "Pos ", ais::format::latlon(entry_.last_position.latitude, entry_.last_position.longitude));
 	field_rect = draw_field(painter, field_rect, s, "Stat", ais::format::navigational_status(entry_.navigational_status));
@@ -352,7 +384,7 @@ AISAppView::AISAppView(NavigationView& nav) : nav_ { nav } {
     	receiver_model.set_sampling_rate(sampling_rate);
     	receiver_model.set_baseband_bandwidth(baseband_bandwidth);
     	receiver_model.enable();  // Before using radio::enable(), but not updating Ant.DC-Bias.
-	
+
 	options_channel.on_change = [this](size_t, OptionsField::value_t v) {
 		this->on_frequency_changed(v);
 	};

firmware/application/apps/ert_app.cpp

@@ -113,8 +113,12 @@ ERTAppView::ERTAppView(NavigationView&) {
 		field_rf_amp.set_value(app_settings.rx_amp);
 	}
 
+	receiver_model.set_tuning_frequency(initial_target_frequency);
+	receiver_model.set_sampling_rate(sampling_rate);
+	receiver_model.set_baseband_bandwidth(baseband_bandwidth);
+	receiver_model.enable();  // Before using radio::enable(), but not updating Ant.DC-Bias.
 
-	radio::enable({
+/*	radio::enable({
 		initial_target_frequency,
 		sampling_rate,
 		baseband_bandwidth,
@@ -122,7 +126,7 @@ ERTAppView::ERTAppView(NavigationView&) {
 		receiver_model.rf_amp(),
 		static_cast<int8_t>(receiver_model.lna()),
 		static_cast<int8_t>(receiver_model.vga()),
-	});
+	}); */
 
 	logger = std::make_unique<ERTLogger>();
 	if( logger ) {
@@ -135,7 +139,7 @@ ERTAppView::~ERTAppView() {
 	// save app settings
 	settings.save("rx_ert", &app_settings);
 
-	radio::disable();
+	receiver_model.disable(); // to switch off all, including DC bias and change flag enabled_
 
 	baseband::shutdown();
 }

firmware/application/apps/tpms_app.cpp

@@ -161,7 +161,12 @@ TPMSAppView::TPMSAppView(NavigationView&) {
 	}
 	else options_band.set_by_value(receiver_model.tuning_frequency());
 
-	radio::enable({
+    receiver_model.set_tuning_frequency(tuning_frequency());
+    receiver_model.set_sampling_rate(sampling_rate);
+    receiver_model.set_baseband_bandwidth(baseband_bandwidth);
+    receiver_model.enable();  // Before using radio::enable(), but not updating Ant.DC-Bias.
+	
+/*	radio::enable({
 		tuning_frequency(),
 		sampling_rate,
 		baseband_bandwidth,
@@ -169,7 +174,7 @@ TPMSAppView::TPMSAppView(NavigationView&) {
 		receiver_model.rf_amp(),
 		static_cast<int8_t>(receiver_model.lna()),
 		static_cast<int8_t>(receiver_model.vga()),
-	});
+	}); */
 
 	options_band.on_change = [this](size_t, OptionsField::value_t v) {
 		this->on_band_changed(v);
@@ -200,7 +205,7 @@ TPMSAppView::~TPMSAppView() {
 	app_settings.rx_frequency = target_frequency_;
 	settings.save("rx_tpms", &app_settings);
 
-	radio::disable();
+	receiver_model.disable(); // to switch off all, including DC bias and change flag enabled_
 
 	baseband::shutdown();
 }

firmware/application/apps/ui_playlist.cpp

@@ -0,0 +1,328 @@
+/*
+ * Copyright (C) 2016 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2016 Furrtek
+ * Copyleft  (ↄ) 2022 NotPike
+ *
+ * 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 "ui_playlist.hpp"
+#include "string_format.hpp"
+
+#include "ui_fileman.hpp"
+#include "io_file.hpp"
+
+#include "baseband_api.hpp"
+#include "portapack.hpp"
+#include "portapack_persistent_memory.hpp"
+#include <unistd.h>
+
+using namespace portapack;
+
+namespace ui {
+
+void PlaylistView::set_ready() {
+	ready_signal = true;
+}
+
+
+	void PlaylistView::load_file(std::filesystem::path playlist_path) {
+		File playlist_file;
+		
+		auto error = playlist_file.open(playlist_path.string());
+		if (!error.is_valid()) {
+			std::string line;
+			char one_char[1];
+			for (size_t pointer =0 ; pointer < playlist_file.size(); pointer++) {
+				playlist_file.seek(pointer);
+				playlist_file.read(one_char, 1);
+				if ((int) one_char[0] >= ' ') {
+					line += one_char[0];
+				} else if (one_char[0] == '\n') {
+					txtline_process(line); 
+					line.clear();
+				}
+			}
+			if (line.length() > 0) {
+				txtline_process(line); 
+			}
+		}
+		playlist_masterdb = playlist_db;
+		return ;
+		}
+
+
+	void PlaylistView::txtline_process(std::string &line) {
+		playlist_entry new_item;
+				rf::Frequency f;
+				size_t previous = 0;
+				size_t current = line.find(',');
+				std::string freqs = line.substr(0, current);
+				previous = current +1;
+				current = line.find(',', previous);
+				std::string file = line.substr(previous, current - previous);
+				previous = current +1;
+				current = line.find(',', previous);
+				uint32_t sample_rate = strtoll(line.substr(previous).c_str(), nullptr,  10);
+
+				f = strtoll(freqs.c_str(), nullptr, 0);
+				new_item.replay_frequency = f;
+				new_item.replay_file = "/" + file;
+				new_item.sample_rate = sample_rate;
+				new_item.next_delay = 0;
+
+					playlist_db.push_back(std::move(new_item));
+	}
+
+void PlaylistView::on_file_changed(std::filesystem::path new_file_path, rf::Frequency replay_frequency, uint32_t replay_sample_rate) {
+	File data_file;	
+	// Get file size
+	auto data_open_error = data_file.open("/" + new_file_path.string());
+	if (data_open_error.is_valid()) {
+		file_error();
+		return;
+	}
+	
+	file_path = new_file_path;
+	field_frequency.set_value(replay_frequency);
+	
+	sample_rate = replay_sample_rate;
+	
+	text_sample_rate.set(unit_auto_scale(sample_rate, 3, 0) + "Hz");
+	
+	auto file_size = data_file.size();
+	auto duration = (file_size * 1000) / (2 * 2 * sample_rate);
+	
+	progressbar.set_max(file_size);
+	text_filename.set(file_path.filename().string().substr(0, 12));
+	text_duration.set(to_string_time_ms(duration));
+	
+	button_play.focus();
+}
+
+void PlaylistView::on_tx_progress(const uint32_t progress) {
+	progressbar.set_value(progress);
+}
+
+void PlaylistView::focus() {
+	button_open.focus();
+}
+
+void PlaylistView::file_error() {
+	nav_.display_modal("Error", "File "+file_path.string() +" read error. " +file_path.string());
+}
+
+bool PlaylistView::is_active() const {
+	return (bool)replay_thread;
+}
+
+bool PlaylistView::loop() const {
+	return (bool) playlist_db.size();
+}
+
+void PlaylistView::toggle() {
+	if( is_active() ) {
+		stop(false);
+	} else {
+
+		start();
+	}
+}
+
+void PlaylistView::start() {
+	stop(false);
+
+		playlist_entry item = playlist_db.front();
+		playlist_db.pop_front();
+	//		playlist_entry item = playlist_db[0];
+//	for (playlist_entry item : playlist_db) {
+	//	file_path = item.replay_file;
+	//	rf::Frequency replay_frequency = strtoll(item.replay_frequency.c_str(),nullptr,10);
+		on_file_changed(item.replay_file, item.replay_frequency, item.sample_rate);
+		on_target_frequency_changed(item.replay_frequency);
+
+		std::unique_ptr<stream::Reader> reader;
+		
+		auto p = std::make_unique<FileReader>();
+		auto open_error = p->open(file_path);
+		if( open_error.is_valid() ) {
+			file_error();
+			return;                               // Fixes TX bug if there's a file error
+		} else {
+			reader = std::move(p);
+		}
+
+		if( reader ) {
+			button_play.set_bitmap(&bitmap_stop);
+			baseband::set_sample_rate(sample_rate * 8);
+			
+			replay_thread = std::make_unique<ReplayThread>(
+				std::move(reader),
+				read_size, buffer_count,
+				&ready_signal,
+				[](uint32_t return_code) {
+					ReplayThreadDoneMessage message { return_code };
+					EventDispatcher::send_message(message);
+				}
+			);
+		}
+		field_rfgain.on_change = [this](int32_t v) {
+			tx_gain = v;
+		};  
+		field_rfgain.set_value(tx_gain);
+		receiver_model.set_tx_gain(tx_gain); 
+		
+
+		field_rfamp.on_change = [this](int32_t v) {
+			rf_amp = (bool)v;
+		};
+		field_rfamp.set_value(rf_amp ? 14 : 0);
+
+		//Enable Bias Tee if selected
+		radio::set_antenna_bias(portapack::get_antenna_bias());
+			
+		radio::enable({
+			receiver_model.tuning_frequency(),
+			sample_rate * 8,
+			baseband_bandwidth,
+			rf::Direction::Transmit,
+			rf_amp,         //  previous code line : "receiver_model.rf_amp()," was passing the same rf_amp of all Receiver Apps  
+			static_cast<int8_t>(receiver_model.lna()),
+			static_cast<int8_t>(receiver_model.vga())
+		});  
+
+//	}
+} 
+
+void PlaylistView::stop(const bool do_loop) {
+	if( is_active() ) {
+		replay_thread.reset();
+	}
+	if (do_loop) {
+		if (playlist_db.size() > 0 ) {
+			start();
+		} else {
+			playlist_db = playlist_masterdb;
+			start();
+		}
+	} else {
+		radio::set_antenna_bias(false);    //Turn off Bias Tee
+		radio::disable();
+		button_play.set_bitmap(&bitmap_play);
+	}
+	
+	ready_signal = false;
+}
+
+void PlaylistView::handle_replay_thread_done(const uint32_t return_code) {
+	if (return_code == ReplayThread::END_OF_FILE) {
+			stop(true);
+	} else if (return_code == ReplayThread::READ_ERROR) {
+		stop(false);
+		file_error();
+	}
+	
+	progressbar.set_value(0);
+}
+
+PlaylistView::PlaylistView(
+	NavigationView& nav
+) : nav_ (nav)
+{
+
+	tx_gain = 35;field_rfgain.set_value(tx_gain);  // Initial default  value (-12 dB's max ).
+	field_rfamp.set_value(rf_amp ? 14 : 0);  // Initial default value True. (TX RF amp on , +14dB's)
+
+	baseband::run_image(portapack::spi_flash::image_tag_replay);
+
+	add_children({
+		&labels,
+		&button_open,
+		&text_filename,
+		&text_sample_rate,
+		&text_duration,
+		&progressbar,
+		&field_frequency,
+		&field_rfgain, 
+		&field_rfamp,       // let's not use common rf_amp
+		&check_loop,
+		&button_play,
+		&waterfall,
+	});
+	
+	field_frequency.set_value(target_frequency());
+	field_frequency.set_step(receiver_model.frequency_step());
+	field_frequency.on_change = [this](rf::Frequency f) {
+		this->on_target_frequency_changed(f);
+	};
+	field_frequency.on_edit = [this, &nav]() {
+		// TODO: Provide separate modal method/scheme?
+		auto new_view = nav.push<FrequencyKeypadView>(this->target_frequency());
+		new_view->on_changed = [this](rf::Frequency f) {
+			this->on_target_frequency_changed(f);
+			this->field_frequency.set_value(f);
+		};
+	};
+
+	field_frequency.set_step(5000);
+	
+	button_play.on_select = [this](ImageButton&) {
+		this->toggle();
+	};
+	
+	button_open.on_select = [this, &nav](Button&) {
+		auto open_view = nav.push<FileLoadView>(".TXT");
+		open_view->on_changed = [this](std::filesystem::path new_file_path) {
+			load_file(new_file_path);
+		};
+	};
+}
+
+PlaylistView::~PlaylistView() {
+	radio::disable();
+	baseband::shutdown();
+}
+
+void PlaylistView::on_hide() {
+	stop(false);
+	// TODO: Terrible kludge because widget system doesn't notify Waterfall that
+	// it's being shown or hidden.
+	waterfall.on_hide();
+	View::on_hide();
+}
+
+void PlaylistView::set_parent_rect(const Rect new_parent_rect) {
+	View::set_parent_rect(new_parent_rect);
+
+	const ui::Rect waterfall_rect { 0, header_height, new_parent_rect.width(), new_parent_rect.height() - header_height };
+	waterfall.set_parent_rect(waterfall_rect);
+}
+
+void PlaylistView::on_target_frequency_changed(rf::Frequency f) {
+	set_target_frequency(f);
+}
+
+void PlaylistView::set_target_frequency(const rf::Frequency new_value) {
+	persistent_memory::set_tuned_frequency(new_value);;
+}
+
+rf::Frequency PlaylistView::target_frequency() const {
+	return persistent_memory::tuned_frequency();
+}
+
+} /* namespace ui */

firmware/application/apps/ui_playlist.hpp

@@ -0,0 +1,176 @@
+/*
+ * Copyright (C) 2016 Jared Boone, ShareBrained Technology, Inc.
+ * Copyright (C) 2016 Furrtek
+ *
+ * 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 "ui_widget.hpp"
+#include "ui_navigation.hpp"
+#include "ui_receiver.hpp"
+#include "replay_thread.hpp"
+#include "ui_spectrum.hpp"
+
+#include <string>
+#include <memory>
+#include <deque>
+
+namespace ui {
+
+class PlaylistView : public View {
+public:
+	PlaylistView(NavigationView& nav);
+	~PlaylistView();
+
+	void on_hide() override;
+	void set_parent_rect(const Rect new_parent_rect) override;
+	void focus() override;
+
+	std::string title() const override { return "Playlist"; };
+	
+private:
+	NavigationView& nav_;
+	
+	static constexpr ui::Dim header_height = 3 * 16;
+	
+	struct playlist_entry {
+		rf::Frequency replay_frequency { 0 };
+		std::string replay_file{};
+		uint32_t sample_rate{};
+		uint32_t next_delay{};
+	};
+	std::deque<playlist_entry> playlist_db{};
+	std::deque<playlist_entry> playlist_masterdb{};
+	uint32_t sample_rate = 0;
+	int32_t tx_gain { 47 };
+	bool rf_amp { true }; // aux private var to store temporal, Replay App rf_amp user selection.
+	static constexpr uint32_t baseband_bandwidth = 2500000;
+	const size_t read_size { 16384 };
+	const size_t buffer_count { 3 };
+	void load_file(std::filesystem::path playlist_path);
+	void txtline_process(std::string &);
+	void on_file_changed(std::filesystem::path new_file_path, rf::Frequency replay_frequency, uint32_t replay_sample_rate);
+	void on_target_frequency_changed(rf::Frequency f);
+	void on_tx_progress(const uint32_t progress);
+	
+	void set_target_frequency(const rf::Frequency new_value);
+	rf::Frequency target_frequency() const;
+
+	void toggle();
+	void start();
+	void stop(const bool do_loop);
+	bool is_active() const;
+	bool loop() const;
+	void set_ready();
+	void handle_replay_thread_done(const uint32_t return_code);
+	void file_error();
+
+	std::filesystem::path file_path { };
+	std::unique_ptr<ReplayThread> replay_thread { };
+	bool ready_signal { false };
+
+	Labels labels {
+		{ { 10 * 8, 2 * 16 }, "GAIN   A:", Color::light_grey() }
+	};
+	
+	Button button_open {
+		{ 0 * 8, 0 * 16, 10 * 8, 2 * 16 },
+		"Open file"
+	};
+
+	
+	Text text_filename {
+		{ 11 * 8, 0 * 16, 12 * 8, 16 },
+		"-"
+	};
+	Text text_sample_rate {
+		{ 24 * 8, 0 * 16, 6 * 8, 16 },
+		"-"
+	};
+	
+	Text text_duration {
+		{ 11 * 8, 1 * 16, 6 * 8, 16 },
+		"-"
+	};
+	ProgressBar progressbar {
+		{ 18 * 8, 1 * 16, 12 * 8, 16 }
+	};
+	
+	FrequencyField field_frequency {
+		{ 0 * 8, 2 * 16 },
+	};
+	
+	NumberField field_rfgain {
+		{ 14 * 8, 2 * 16 },
+		2,
+		{ 0, 47 },
+		1,
+		' '	
+	};
+	NumberField field_rfamp {     // previously  I was using "RFAmpField field_rf_amp" but that is general Receiver amp setting.
+		{ 19 * 8, 2 * 16 },
+		2,
+		{ 0, 14 },                // this time we will display GUI , 0 or 14 dBs same as Mic App
+		14,
+		' '
+	};
+	Checkbox check_loop {
+		{ 21 * 8, 2 * 16 },
+		4,
+		"Loop",
+		true
+	};
+	ImageButton button_play {
+		{ 28 * 8, 2 * 16, 2 * 8, 1 * 16 },
+		&bitmap_play,
+		Color::green(),
+		Color::black()
+	};
+
+	spectrum::WaterfallWidget waterfall { };
+
+	MessageHandlerRegistration message_handler_replay_thread_error {
+		Message::ID::ReplayThreadDone,
+		[this](const Message* const p) {
+			const auto message = *reinterpret_cast<const ReplayThreadDoneMessage*>(p);
+			this->handle_replay_thread_done(message.return_code);
+		}
+	};
+	
+	MessageHandlerRegistration message_handler_fifo_signal {
+		Message::ID::RequestSignal,
+		[this](const Message* const p) {
+			const auto message = static_cast<const RequestSignalMessage*>(p);
+			if (message->signal == RequestSignalMessage::Signal::FillRequest) {
+				this->set_ready();
+			}
+		}
+	};
+	
+	MessageHandlerRegistration message_handler_tx_progress {
+		Message::ID::TXProgress,
+		[this](const Message* const p) {
+			const auto message = *reinterpret_cast<const TXProgressMessage*>(p);
+			this->on_tx_progress(message.progress);
+		}
+	};
+};
+
+} /* namespace ui */

firmware/application/apps/ui_scanner.cpp

@@ -540,7 +540,7 @@ size_t ScannerView::change_mode(uint8_t new_mod) { //Before this, do a scan_thre
 		field_bw.set_selected_index(0);
 		receiver_model.set_am_configuration(field_bw.selected_index());
 		field_bw.on_change = [this](size_t n, OptionsField::value_t) { receiver_model.set_am_configuration(n);	};		
-		receiver_model.set_sampling_rate(2000000);receiver_model.set_baseband_bandwidth(2000000); 
+		receiver_model.set_sampling_rate(3072000);	receiver_model.set_baseband_bandwidth(1750000); 
 		break;
 	case WFM:
 		bw.emplace_back("16k", 0);

firmware/application/apps/ui_settings.cpp

@@ -245,13 +245,9 @@ SetUIView::SetUIView(NavigationView& nav) {
 	checkbox_showclock.set_value(!persistent_memory::hide_clock());
 	checkbox_guireturnflag.set_value(persistent_memory::show_gui_return_icon());
 	
-	uint32_t backlight_timer = persistent_memory::config_backlight_timer();
-	if (backlight_timer) {
-		checkbox_bloff.set_value(true);
-		options_bloff.set_by_value(backlight_timer);
-	} else {
-		options_bloff.set_selected_index(0);
-	}
+	const auto backlight_config = persistent_memory::config_backlight_timer();
+	checkbox_bloff.set_value(backlight_config.timeout_enabled());
+	options_bloff.set_by_value(backlight_config.timeout_enum());
 
 	if (persistent_memory::clock_with_date()) {
 		options_clockformat.set_selected_index(1);
@@ -261,11 +257,11 @@ SetUIView::SetUIView(NavigationView& nav) {
 
 
 	button_save.on_select = [&nav, this](Button&) {
-		if (checkbox_bloff.value())
-			persistent_memory::set_config_backlight_timer(options_bloff.selected_index() + 1);
-		else
-			persistent_memory::set_config_backlight_timer(0);
-		
+		persistent_memory::set_config_backlight_timer({
+			(persistent_memory::backlight_timeout_t)options_bloff.selected_index_value(),
+			checkbox_bloff.value()
+		});
+				
 		if (checkbox_showclock.value()){
 		    if (options_clockformat.selected_index() == 1)
 			    persistent_memory::set_clock_with_date(true);    

firmware/application/apps/ui_settings.hpp

@@ -27,6 +27,7 @@
 #include "ui_menu.hpp"
 #include "ui_navigation.hpp"
 #include "ff.h"
+#include "portapack_persistent_memory.hpp"
 
 #include <cstdint>
 
@@ -210,6 +211,8 @@ private:
 	SetFrequencyCorrectionModel form_collect();
 };
 
+using portapack::persistent_memory::backlight_timeout_t;
+
 class SetUIView : public View {
 public:
 	SetUIView(NavigationView& nav);
@@ -241,13 +244,14 @@ private:
 		{ 52, 7 * 16 + 8 },
 		20,
 		{
-			{ "5 seconds", 5 },
-			{ "15 seconds", 15 },
-			{ "30 seconds", 30 },
-			{ "1 minute", 60 },
-			{ "3 minutes", 180 },
-			{ "5 minutes", 300 },
-			{ "10 minutes", 600 }
+			{ "5 seconds",  backlight_timeout_t::Timeout5Sec    },
+			{ "15 seconds", backlight_timeout_t::Timeout15Sec   },
+			{ "30 seconds", backlight_timeout_t::Timeout30Sec   },
+			{ "1 minute",   backlight_timeout_t::Timeout60Sec   },
+			{ "3 minutes",  backlight_timeout_t::Timeout180Sec  },
+			{ "5 minutes",  backlight_timeout_t::Timeout300Sec  },
+			{ "10 minutes", backlight_timeout_t::Timeout600Sec  },
+			{ "1 hour",     backlight_timeout_t::Timeout3600Sec },
 		}
 	};
 	

firmware/application/apps/ui_touch_calibration.cpp

@@ -31,7 +31,7 @@ namespace ui {
 TouchCalibrationView::TouchCalibrationView(
 	NavigationView& nav
 ) : nav { nav },
-	calibration { touch::default_calibration() }
+	calibration { touch::Calibration() }
 {
 	add_children({
 		&image_calibrate_0,

firmware/application/event_m0.cpp

@@ -226,15 +226,17 @@ void EventDispatcher::handle_rtc_tick() {
 
 	portapack::temperature_logger.second_tick();
 	
-	uint32_t backlight_timer = portapack::persistent_memory::config_backlight_timer();
-	if (backlight_timer) {
-		if (portapack::bl_tick_counter == backlight_timer)
+	const auto backlight_timer = portapack::persistent_memory::config_backlight_timer();
+	if (backlight_timer.timeout_enabled()) {
+		if (portapack::bl_tick_counter == backlight_timer.timeout_seconds())
 			set_display_sleep(true);
 		else
 			portapack::bl_tick_counter++;
 	}
 
 	rtc_time::on_tick_second();
+
+	portapack::persistent_memory::cache::persist();
 }
 
 ui::Widget* EventDispatcher::touch_widget(ui::Widget* const w, ui::TouchEvent event) {

firmware/application/portapack.cpp

@@ -215,7 +215,7 @@ static int load_config(){
 	static Optional<int> config_value;
 	if(!config_value.is_valid()){
 		int8_t value = portapack::persistent_memory::config_cpld();
-		if((value <= 0 || value >= 4) && sd_card::status() == sd_card::Status::Mounted){
+		if((value <= 0 || value >= 5) && sd_card::status() == sd_card::Status::Mounted){
 			int data = read_file("/hardware/settings.txt");
 			if(data != -1) {
 				config_value = data;
@@ -235,14 +235,19 @@ static PortaPackModel portapack_model() {
 		const auto switches_state = get_switches_state();
 		if (switches_state[(size_t)ui::KeyEvent::Up]){
 			save_config(1);
-			model = PortaPackModel::R2_20170522;
+			// model = PortaPackModel::R2_20170522; // Commented these out as they should be set down below anyway
 		}
 		else if (switches_state[(size_t)ui::KeyEvent::Down]){
 			save_config(2);
-			model = PortaPackModel::R1_20150901;
+			// model = PortaPackModel::R1_20150901;
 		}
 		else if (switches_state[(size_t)ui::KeyEvent::Left]){
 			save_config(3);
+			// model = PortaPackModel::R1_20150901;
+		}
+		else if (switches_state[(size_t)ui::KeyEvent::Right]){
+			save_config(4);
+			// model = PortaPackModel::R2_20170522;
 		}
 		else if (switches_state[(size_t)ui::KeyEvent::Select]){
 			save_config(0);
@@ -253,6 +258,10 @@ static PortaPackModel portapack_model() {
 			model = PortaPackModel::R2_20170522;
 		} else if (load_config() == 2) {
 			model = PortaPackModel::R1_20150901;
+		} else if (load_config() == 3) {
+			model = PortaPackModel::R1_20150901;
+		} else if (load_config() == 4) {
+			model = PortaPackModel::R2_20170522;
 		} else {
 			if( audio_codec_wm8731.detected() ) {
 				model = PortaPackModel::R1_20150901; // H1R1
@@ -457,6 +466,9 @@ bool init() {
 	i2c0.start(i2c_config_fast_clock);
 	chThdSleepMilliseconds(10);
 
+	/* Cache some configuration data from persistent memory. */
+	persistent_memory::cache::init();
+
 	touch::adc::init();
 	controls_init();
 	chThdSleepMilliseconds(10);
@@ -475,7 +487,7 @@ bool init() {
 	if( !portapack::cpld::update_if_necessary(portapack_cpld_config()) ) {
 		chThdSleepMilliseconds(10);
 		// If using a "2021/12 QFP100", press and hold the left button while booting. Should only need to do once.
-		if (load_config() != 3){
+		if (load_config() != 3 && load_config() != 4){
 			shutdown_base();
 			return false;
 		}

firmware/application/serializer.hpp

@@ -45,6 +45,14 @@ struct serial_format_t {
 	parity_enum parity;
 	uint8_t stop_bits;
 	order_enum bit_order;
+
+	constexpr serial_format_t() :
+		data_bits(7),
+		parity(parity_enum::EVEN),
+		stop_bits(1),
+		bit_order(order_enum::LSB_FIRST)
+	{
+	}
 };
 
 size_t symbol_count(const serial_format_t& serial_format);

firmware/application/touch.cpp

@@ -76,14 +76,6 @@ ui::Point Calibration::translate(const DigitizerPoint& p) const {
 	return { x_clipped, y_clipped };
 }
 
-const Calibration default_calibration() {
-	/* Values derived from one PortaPack H1 unit. */
-	return {
-		{ { { 256, 731 }, { 880, 432 }, { 568, 146 } } },
-		{ { {  32,  48 }, { 208, 168 }, { 120, 288 } } }
-	};
-};
-
 void Manager::feed(const Frame& frame) {
 	// touch_debounce.feed(touch_raw);
 	const auto touch_raw = frame.touch;

firmware/application/touch.hpp

@@ -137,6 +137,15 @@ struct Calibration {
 	{
 	}
 
+	constexpr Calibration() :
+		Calibration(
+			/* Values derived from one PortaPack H1 unit. */
+			{ { { 256, 731 }, { 880, 432 }, { 568, 146 } } },
+			{ { {  32,  48 }, { 208, 168 }, { 120, 288 } } }
+		)
+	{
+	}
+
 	ui::Point translate(const DigitizerPoint& p) const;
 
 private:
@@ -149,8 +158,6 @@ private:
 	int32_t f;
 };
 
-const Calibration default_calibration();
-
 template<size_t N>
 class Filter {
 public:

firmware/application/ui/ui_receiver.hpp

@@ -247,6 +247,8 @@ public:
 			parent_pos,
 			5,
 			{
+				{ "   10",       10 },  /* Fine tuning SSB voice pitch,in HF and QO-100 sat #669 */
+				{ "   50",       50 },	/* added 50Hz/10Hz,but we do not increase GUI digit decimal */
 				{ "  100",      100 },
 				{ "  1k ",     1000 },
 				{ "  3k ",     3000 },	/* Approximate SSB bandwidth */

firmware/application/ui_navigation.cpp

@@ -65,6 +65,7 @@
 //#include "ui_test.hpp"
 #include "ui_tone_search.hpp"
 #include "ui_touchtunes.hpp"
+#include "ui_playlist.hpp"
 #include "ui_view_wav.hpp"
 #include "ui_whipcalc.hpp"
 
@@ -518,6 +519,8 @@ TransmittersMenuView::TransmittersMenuView(NavigationView& nav) {
 		{ "SSTV", 			ui::Color::green(), 	&bitmap_icon_sstv,		[&nav](){ nav.push<SSTVTXView>(); } },
 		{ "TEDI/LCR",		ui::Color::yellow(), 	&bitmap_icon_lcr,		[&nav](){ nav.push<LCRView>(); } },
 		{ "TouchTune",		ui::Color::yellow(),	&bitmap_icon_remote,	[&nav](){ nav.push<TouchTunesView>(); } },
+                { "Playlist",           ui::Color::yellow(),    &bitmap_icon_remote,    [&nav](){ nav.push<PlaylistView>(); } },
+
 		//{ "Remote",			ui::Color::dark_grey(),	&bitmap_icon_remote,	[&nav](){ nav.push<RemoteView>(); } },
 	});
 }
@@ -536,9 +539,10 @@ UtilitiesMenuView::UtilitiesMenuView(NavigationView& nav) {
 		//{ "Notepad",		ui::Color::dark_grey(),	&bitmap_icon_notepad,		[&nav](){ nav.push<NotImplementedView>(); } },
 		{ "Signal gen", 	ui::Color::green(), 	&bitmap_icon_cwgen,			[&nav](){ nav.push<SigGenView>(); } },
 		//{ "Tone search",	ui::Color::dark_grey(), nullptr,					[&nav](){ nav.push<ToneSearchView>(); } },
-		{ "WAV viewer",	ui::Color::yellow(),	&bitmap_icon_soundboard,	[&nav](){ nav.push<ViewWavView>(); } },
+		{ "Wav viewer",	ui::Color::yellow(),	&bitmap_icon_soundboard,	[&nav](){ nav.push<ViewWavView>(); } },
 		{ "Antenna length",	ui::Color::green(),		&bitmap_icon_tools_antenna,	[&nav](){ nav.push<WhipCalcView>(); } },
-		{ "Wipe SD Card",	ui::Color::red(),		&bitmap_icon_tools_wipesd,	[&nav](){ nav.push<WipeSDView>(); } },
+
+		{ "Wipe SD card",	ui::Color::red(),		&bitmap_icon_tools_wipesd,	[&nav](){ nav.push<WipeSDView>(); } },
 	});
 	set_max_rows(2); // allow wider buttons
 }

firmware/common/portapack_persistent_memory.cpp

@@ -28,7 +28,8 @@
 #include "utility.hpp"
 
 #include "memory_map.hpp"
-using portapack::memory::map::backup_ram;
+
+#include "crc.hpp"
 
 #include <algorithm>
 #include <utility>
@@ -67,8 +68,193 @@ using clkout_freq_range_t = range_t<uint32_t>;
 constexpr clkout_freq_range_t clkout_freq_range { 10, 60000 };
 constexpr uint32_t clkout_freq_reset_value { 10000 };
 
+enum data_structure_version_enum : uint32_t {
+	VERSION_CURRENT = 0x10000002,
+};
+
+static const uint32_t TOUCH_CALIBRATION_MAGIC = 0x074af82f;
+
+struct ui_config_t {
+private:
+	enum bits_t {
+		BacklightTimeoutLSB    =  0,
+		BacklightTimeoutEnable =  3,
+		ClkoutFreqLSB          =  4,
+		ShowGUIReturnIcon      = 20,
+		LoadAppSettings        = 21,
+		SaveAppSettings        = 22,
+		ShowBiggerQRCode       = 23,
+		DisableTouchscreen     = 24,
+		HideClock              = 25,
+		ClockWithDate          = 26,
+		ClkOutEnabled          = 27,
+		ConfigSpeaker          = 28,
+		StealthMode            = 29,
+		ConfigLogin            = 30,
+		ConfigSplash           = 31,
+	};
+
+	enum bits_mask_t : uint32_t {
+		BacklightTimeoutMask = ((1 <<  3) - 1) << bits_t::BacklightTimeoutLSB,
+		ClkoutFreqMask       = ((1 << 16) - 1) << bits_t::ClkoutFreqLSB,
+	};
+
+	uint32_t values;
+
+	constexpr bool bit_read(const bits_t n) const {
+		return ((values >> n) & 1) != 0;
+	}
+
+	constexpr void bit_write(const bits_t n, const bool v) {
+		if(bit_read(n) != v) {
+			values ^= 1 << n;
+		}
+	}
+
+public:
+	backlight_config_t config_backlight_timer() {
+		const auto timeout_enum = (backlight_timeout_t)((values & bits_mask_t::BacklightTimeoutMask) >> bits_t::BacklightTimeoutLSB);
+		const bool timeout_enabled = bit_read(bits_t::BacklightTimeoutEnable);
+		return backlight_config_t(timeout_enum, timeout_enabled);
+	}
+
+	void set_config_backlight_timer(const backlight_config_t& new_value) {
+		values = (values & ~bits_mask_t::BacklightTimeoutMask)
+			| ((new_value.timeout_enum() << bits_t::BacklightTimeoutLSB) & bits_mask_t::BacklightTimeoutMask);
+		bit_write(bits_t::BacklightTimeoutEnable, new_value.timeout_enabled());
+	}
+
+	constexpr uint32_t clkout_freq() {
+		uint32_t freq = (values & bits_mask_t::ClkoutFreqMask) >> bits_t::ClkoutFreqLSB;
+		if(freq < clkout_freq_range.minimum || freq > clkout_freq_range.maximum) {
+			values = (values & ~bits_mask_t::ClkoutFreqMask) | (clkout_freq_reset_value << bits_t::ClkoutFreqLSB);
+			return clkout_freq_reset_value;
+		}
+		else {
+			return freq;
+		}
+	}
+
+	constexpr void set_clkout_freq(uint32_t freq) {
+		values = (values & ~bits_mask_t::ClkoutFreqMask) | (clkout_freq_range.clip(freq) << bits_t::ClkoutFreqLSB);
+	}
+
+	// ui_config is an uint32_t var storing information bitwise
+	// bits 0-2 store the backlight timer
+	// bits 4-19 (16 bits) store the clkout frequency
+	// bits 21-31 store the different single bit configs depicted below
+	// bit 20 store the display state of the gui return icon, hidden (0) or shown (1)
+
+	constexpr bool show_gui_return_icon() const { // add return icon in touchscreen menue
+		return bit_read(bits_t::ShowGUIReturnIcon);
+	}
+
+	constexpr void set_gui_return_icon(bool v) {
+		bit_write(bits_t::ShowGUIReturnIcon, v);
+	}
+
+	constexpr bool load_app_settings() const { // load (last saved) app settings on startup of app
+		return bit_read(bits_t::LoadAppSettings);
+	}
+
+	constexpr void set_load_app_settings(bool v) {
+		bit_write(bits_t::LoadAppSettings, v);
+	}
+
+	constexpr bool save_app_settings() const { // save app settings when closing app
+		return bit_read(bits_t::SaveAppSettings);
+	}
+
+	constexpr void set_save_app_settings(bool v) {
+		bit_write(bits_t::SaveAppSettings, v);
+	}
+
+	constexpr bool show_bigger_qr_code() const { // show bigger QR code
+		return bit_read(bits_t::ShowBiggerQRCode);
+	}
+
+	constexpr void set_show_bigger_qr_code(bool v) {
+		bit_write(bits_t::ShowBiggerQRCode, v);
+	}
+
+	constexpr bool disable_touchscreen() const { // Option to disable touch screen
+		return bit_read(bits_t::DisableTouchscreen);
+	}
+
+	constexpr void set_disable_touchscreen(bool v) {
+		bit_write(bits_t::DisableTouchscreen, v);
+	}
+
+	constexpr bool hide_clock() const { // clock hidden from main menu
+		return bit_read(bits_t::HideClock);
+	}
+
+	constexpr void set_clock_hidden(bool v) {
+		bit_write(bits_t::HideClock, v);
+	}
+
+	constexpr bool clock_with_date() const { // show clock with date, if not hidden
+		return bit_read(bits_t::ClockWithDate);
+	}
+
+	constexpr void set_clock_with_date(bool v) {
+		bit_write(bits_t::ClockWithDate, v);
+	}
+
+	constexpr bool clkout_enabled() const {
+		return bit_read(bits_t::ClkOutEnabled);
+	}
+
+	constexpr void set_clkout_enabled(bool v) {
+		bit_write(bits_t::ClkOutEnabled, v);
+	}
+
+	constexpr bool config_speaker() const {
+		return bit_read(bits_t::ConfigSpeaker);
+	}
+
+	constexpr void set_config_speaker(bool v) {
+		bit_write(bits_t::ConfigSpeaker, v);
+	}
+
+	constexpr bool stealth_mode() const {
+		return bit_read(bits_t::StealthMode);
+	}
+
+	constexpr void set_stealth_mode(bool v) {
+		bit_write(bits_t::StealthMode, v);
+	}
+
+	constexpr bool config_login() const {
+		return bit_read(bits_t::ConfigLogin);
+	}
+
+	constexpr void set_config_login(bool v) {
+		bit_write(bits_t::ConfigLogin, v);
+	}
+
+	constexpr bool config_splash() const {
+		return bit_read(bits_t::ConfigSplash);
+	}
+
+	constexpr void set_config_splash(bool v) {
+		bit_write(bits_t::ConfigSplash, v);
+	}
+
+	constexpr ui_config_t() :
+		values(
+		      (1 << ConfigSplash)
+			| (1 << ConfigSpeaker)
+			| (clkout_freq_reset_value << ClkoutFreqLSB)
+			| (7 << BacklightTimeoutLSB)
+		)
+	{
+	}
+};
+
 /* struct must pack the same way on M4 and M0 cores. */
 struct data_t {
+	data_structure_version_enum structure_version;
 	int64_t tuned_frequency;
 	int32_t correction_ppb;
 	uint32_t touch_calibration_magic;
@@ -89,7 +275,7 @@ struct data_t {
 	uint32_t playdead_sequence;
 	
 	// UI
-	uint32_t ui_config;
+	ui_config_t ui_config;
 	
 	uint32_t pocsag_last_address;
 	uint32_t pocsag_ignore_address;
@@ -98,11 +284,142 @@ struct data_t {
 
 	// Hardware
 	uint32_t hardware_config;
+
+	constexpr data_t() :
+		structure_version(data_structure_version_enum::VERSION_CURRENT),
+		tuned_frequency(tuned_frequency_reset_value),
+		correction_ppb(ppb_reset_value),
+		touch_calibration_magic(TOUCH_CALIBRATION_MAGIC),
+		touch_calibration(touch::Calibration()),
+
+		modem_def_index(0),			// TODO: Unused?
+		serial_format(),
+		modem_bw(15000),			// TODO: Unused?
+		afsk_mark_freq(afsk_mark_reset_value),
+		afsk_space_freq(afsk_space_reset_value),
+		modem_baudrate(modem_baudrate_reset_value),
+		modem_repeat(modem_repeat_reset_value),
+
+		playdead_magic(),			// TODO: Unused?
+		playing_dead(),				// TODO: Unused?
+		playdead_sequence(),		// TODO: Unused?
+
+		ui_config(),
+
+		pocsag_last_address(0),		// TODO: A better default?
+		pocsag_ignore_address(0),	// TODO: A better default?
+
+		tone_mix(tone_mix_reset_value),
+
+		hardware_config(0)
+	{
+	}
 };
 
-static_assert(sizeof(data_t) <= backup_ram.size(), "Persistent memory structure too large for VBAT-maintained region");
+struct backup_ram_t {
+private:
+	uint32_t regfile[63];
+	uint32_t check_value;
 
-static data_t* const data = reinterpret_cast<data_t*>(backup_ram.base());
+	static void copy(const backup_ram_t& src, backup_ram_t& dst) {
+		for(size_t i=0; i<63; i++) {
+			dst.regfile[i] = src.regfile[i];
+		}
+		dst.check_value = src.check_value;
+	}
+
+	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++) {
+			if(i<word_count) {
+				dst.regfile[i] = src_words[i];
+			} else {
+				dst.regfile[i] = 0;
+			}
+		}
+	}
+
+	uint32_t compute_check_value() {
+		CRC<32> crc { 0x04c11db7, 0xffffffff, 0xffffffff };
+		for(size_t i=0; i<63; i++) {
+			const auto word = regfile[i];
+			crc.process_byte((word >>  0) & 0xff);
+			crc.process_byte((word >>  8) & 0xff);
+			crc.process_byte((word >> 16) & 0xff);
+			crc.process_byte((word >> 24) & 0xff);
+		}
+		return crc.checksum();
+	}
+
+public:
+	/* default constructor */
+	backup_ram_t() :
+		check_value(0)
+	{
+		const data_t defaults = data_t();
+		copy_from_data_t(defaults, *this);
+	}
+
+	/* copy-assignment operator */
+	backup_ram_t& operator=(const backup_ram_t& src) {
+		copy(src, *this);
+		return *this;
+	}
+
+	/* Calculate a check value from `this`, and check against
+	 * the stored value.
+	 */
+	bool is_valid() {
+		return compute_check_value() == check_value;
+	}
+
+	/* Assuming `this` contains valid data, update the checksum
+	 * and copy to the destination.
+	 */
+	void persist_to(backup_ram_t& dst) {
+		check_value = compute_check_value();
+		copy(*this, dst);
+	}
+};
+
+static_assert(sizeof(backup_ram_t) == memory::map::backup_ram.size());
+static_assert(sizeof(data_t) <= sizeof(backup_ram_t) - sizeof(uint32_t));
+
+static backup_ram_t* const backup_ram = reinterpret_cast<backup_ram_t*>(memory::map::backup_ram.base());
+
+static backup_ram_t cached_backup_ram;
+static data_t* const data = reinterpret_cast<data_t*>(&cached_backup_ram);
+
+namespace cache {
+
+void defaults() {
+	cached_backup_ram = backup_ram_t();
+}
+
+void init() {
+	if(backup_ram->is_valid()) {
+		// Copy valid persistent data into cache.
+		cached_backup_ram = *backup_ram;
+
+		// Check that structure data we copied into cache is the expected
+		// version. If not, initialize cache to defaults.
+		if(data->structure_version != data_structure_version_enum::VERSION_CURRENT) {
+			// TODO: Can provide version-to-version upgrade functions here,
+			// if we want to be fancy.
+			defaults();
+		}
+	} else {
+		// Copy defaults into cache.
+		defaults();
+	}
+}
+
+void persist() {
+	cached_backup_ram.persist_to(*backup_ram);
+}
+
+} /* namespace cache */
 
 rf::Frequency tuned_frequency() {
 	rf::tuning_range.reset_if_outside(data->tuned_frequency, tuned_frequency_reset_value);
@@ -124,16 +441,14 @@ void set_correction_ppb(const ppb_t new_value) {
 	portapack::clock_manager.set_reference_ppb(clipped_value);
 }
 
-static constexpr uint32_t touch_calibration_magic = 0x074af82f;
-
 void set_touch_calibration(const touch::Calibration& new_value) {
 	data->touch_calibration = new_value;
-	data->touch_calibration_magic = touch_calibration_magic;
+	data->touch_calibration_magic = TOUCH_CALIBRATION_MAGIC;
 }
 
 const touch::Calibration& touch_calibration() {
-	if( data->touch_calibration_magic != touch_calibration_magic ) {
-		set_touch_calibration(touch::default_calibration());
+	if( data->touch_calibration_magic != TOUCH_CALIBRATION_MAGIC ) {
+		set_touch_calibration(touch::Calibration());
 	}
 	return data->touch_calibration;
 }
@@ -200,122 +515,116 @@ void set_serial_format(const serial_format_t new_value) {
 	data->serial_format = new_value;
 }
 
-// ui_config is an uint32_t var storing information bitwise
-// bits 0-2 store the backlight timer
-// bits 4-19 (16 bits) store the clkout frequency
-// bits 21-31 store the different single bit configs depicted below
-// bit 20 store the display state of the gui return icon, hidden (0) or shown (1)
-
-bool show_gui_return_icon(){ // add return icon in touchscreen menue
-return data->ui_config & (1 << 20);
+bool show_gui_return_icon() { // add return icon in touchscreen menue
+	return data->ui_config.show_gui_return_icon();
 }
 
 bool load_app_settings() { // load (last saved) app settings on startup of app
-	return data->ui_config & (1 << 21);
+	return data->ui_config.load_app_settings();
 }
 
 bool save_app_settings() { // save app settings when closing app
-	return data->ui_config & (1 << 22);
+	return data->ui_config.save_app_settings();
 }
   
 bool show_bigger_qr_code() { // show bigger QR code
-	return data->ui_config & (1 << 23);
+	return data->ui_config.show_bigger_qr_code();
 }
 
 bool disable_touchscreen() { // Option to disable touch screen
-	return data->ui_config & (1 << 24);
+	return data->ui_config.disable_touchscreen();
 }
 
 bool hide_clock() { // clock hidden from main menu
-	return data->ui_config & (1 << 25);
+	return data->ui_config.hide_clock();
 }
 
 bool clock_with_date() { // show clock with date, if not hidden
-	return data->ui_config & (1 << 26);
+	return data->ui_config.clock_with_date();
 }
 
 bool clkout_enabled() {
-	return data->ui_config & (1 << 27);
+	return data->ui_config.clkout_enabled();
 }
 
 bool config_speaker() {
-	return data->ui_config & (1 << 28);
+	return data->ui_config.config_speaker();
 }
+
 bool stealth_mode() {
-	return data->ui_config & (1 << 29);
+	return data->ui_config.stealth_mode();
 }
 
 bool config_login() {
-	return data->ui_config & (1 << 30);
+	return data->ui_config.config_login();
 }
 
 bool config_splash() {
-	return data->ui_config & (1 << 31);
+	return data->ui_config.config_splash();
 }
 
 uint8_t config_cpld() {
 	return data->hardware_config;
 }
 
-uint32_t config_backlight_timer() {
-	const uint32_t timer_seconds[8] = { 0, 5, 15, 30, 60, 180, 300, 600 };
-	return timer_seconds[data->ui_config & 7]; //first three bits, 8 possible values
+backlight_config_t config_backlight_timer() {
+	return data->ui_config.config_backlight_timer();
 }
 
 void set_gui_return_icon(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 20)) | (v << 20);
+	data->ui_config.set_gui_return_icon(v);
 }
 
 void set_load_app_settings(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 21)) | (v << 21);
+	data->ui_config.set_load_app_settings(v);
 }
 
 void set_save_app_settings(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 22)) | (v << 22);
+	data->ui_config.set_save_app_settings(v);
 }
 
 void set_show_bigger_qr_code(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 23)) | (v << 23);
+	data->ui_config.set_show_bigger_qr_code(v);
 }
 
 void set_disable_touchscreen(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 24)) | (v << 24);
+	data->ui_config.set_disable_touchscreen(v);
 }
 
 void set_clock_hidden(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 25)) | (v << 25);
+	data->ui_config.set_clock_hidden(v);
 }
 
 void set_clock_with_date(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 26)) | (v << 26);
+	data->ui_config.set_clock_with_date(v);
 }
 
 void set_clkout_enabled(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 27)) | (v << 27);
+	data->ui_config.set_clkout_enabled(v);
 }
 
 void set_config_speaker(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 28)) | (v << 28);
+	data->ui_config.set_config_speaker(v);
 }
 
 void set_stealth_mode(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 29)) | (v << 29);
+	data->ui_config.set_stealth_mode(v);
 }
 
 void set_config_login(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 30)) | (v << 30);
+	data->ui_config.set_config_login(v);
 }
 
 void set_config_splash(bool v) {
-	data->ui_config = (data->ui_config & ~(1 << 31)) | (v << 31);
+	data->ui_config.set_config_splash(v);
 }
 
 void set_config_cpld(uint8_t i) {
 	data->hardware_config = i;
 }
 
-void set_config_backlight_timer(uint32_t i) {
-	data->ui_config = (data->ui_config & ~7) | (i & 7);
+void set_config_backlight_timer(const backlight_config_t& new_value) {
+	data->ui_config.set_config_backlight_timer(new_value);
 }
 
 /*void set_config_textentry(uint8_t new_value) {
@@ -347,18 +656,11 @@ void set_pocsag_ignore_address(uint32_t address) {
 }
 
 uint32_t clkout_freq() {
-	uint16_t freq = (data->ui_config & 0x000FFFF0) >> 4;
-	if(freq < clkout_freq_range.minimum || freq > clkout_freq_range.maximum) {
-		data->ui_config = (data->ui_config & ~0x000FFFF0) | clkout_freq_reset_value << 4;
-		return clkout_freq_reset_value;
-	}
-	else {
-		return freq;
-	}
+	return data->ui_config.clkout_freq();
 }
 
 void set_clkout_freq(uint32_t freq) {
-	data->ui_config = (data->ui_config & ~0x000FFFF0) | (clkout_freq_range.clip(freq) << 4);
+	data->ui_config.set_clkout_freq(freq);
 }
 
 

firmware/common/portapack_persistent_memory.hpp

@@ -25,6 +25,8 @@
 
 #include <cstdint>
 
+#include "optional.hpp"
+
 #include "rf_path.hpp"
 #include "touch.hpp"
 #include "modems.hpp"
@@ -36,6 +38,77 @@ using namespace serializer;
 namespace portapack {
 namespace persistent_memory {
 
+enum backlight_timeout_t {
+    Timeout5Sec    = 0,
+    Timeout15Sec   = 1,
+    Timeout30Sec   = 2,
+    Timeout60Sec   = 3,
+    Timeout180Sec  = 4,
+    Timeout300Sec  = 5,
+    Timeout600Sec  = 6,
+    Timeout3600Sec = 7,
+};
+
+struct backlight_config_t {
+public:
+    backlight_config_t() :
+        _timeout_enum(backlight_timeout_t::Timeout600Sec),
+        _timeout_enabled(false)
+    {
+    }
+
+    backlight_config_t(
+        backlight_timeout_t timeout_enum,
+        bool timeout_enabled
+    ) :
+        _timeout_enum(timeout_enum),
+        _timeout_enabled(timeout_enabled)
+    {
+    }
+
+    bool timeout_enabled() const {
+        return _timeout_enabled;
+    }
+
+    backlight_timeout_t timeout_enum() const {
+        return _timeout_enum;
+    }
+
+    uint32_t timeout_seconds() const {
+        switch(timeout_enum()) {
+            case Timeout5Sec:    return    5;
+            case Timeout15Sec:   return   15;
+            case Timeout30Sec:   return   30;
+            case Timeout60Sec:   return   60;
+            case Timeout180Sec:  return  180;
+            case Timeout300Sec:  return  300;
+            default:
+            case Timeout600Sec:  return  600;
+            case Timeout3600Sec: return 3600;
+        }
+    }
+
+private:
+    backlight_timeout_t _timeout_enum;
+    bool _timeout_enabled;
+};
+
+namespace cache {
+
+/* Set values in cache to sensible defaults. */
+void defaults();
+
+/* Load cached settings from values in persistent RAM, replacing with defaults
+ * if persistent RAM contents appear to be invalid. */
+void init();
+
+/* Calculate a check value for cached settings, and copy the check value and
+ * settings into persistent RAM. Intended to be called periodically to update
+ * persistent settings with current settings. */
+void persist();
+
+} /* namespace cache */
+
 using ppb_t = int32_t;
 
 rf::Frequency tuned_frequency();
@@ -86,7 +159,7 @@ bool hide_clock();
 bool clock_with_date();
 bool config_login();
 bool config_speaker();
-uint32_t config_backlight_timer();
+backlight_config_t config_backlight_timer();
 bool disable_touchscreen();
 
 void set_gui_return_icon(bool v);
@@ -98,7 +171,7 @@ void set_clock_hidden(bool v);
 void set_clock_with_date(bool v);
 void set_config_login(bool v);
 void set_config_speaker(bool v); 
-void set_config_backlight_timer(uint32_t i);
+void set_config_backlight_timer(const backlight_config_t& new_value);
 void set_disable_touchscreen(bool v);
 
 //uint8_t ui_config_textentry();

firmware/common/utility.hpp

@@ -95,27 +95,27 @@ struct range_t {
 	const T minimum;
 	const T maximum;
 
-	const T& clip(const T& value) const {
+	constexpr const T& clip(const T& value) const {
 		return std::max(std::min(value, maximum), minimum);
 	}
 
-	void reset_if_outside(T& value, const T& reset_value) const {
+	constexpr void reset_if_outside(T& value, const T& reset_value) const {
 		if( (value < minimum ) ||
 			(value > maximum ) ) {
 			value = reset_value;
 		}
 	}
 
-	bool below_range(const T& value) const {
+	constexpr bool below_range(const T& value) const {
 		return value < minimum;
 	}
 
-	bool contains(const T& value) const {
+	constexpr bool contains(const T& value) const {
 		// TODO: Subtle gotcha here! Range test doesn't include maximum!
 		return (value >= minimum) && (value < maximum);
 	}
 
-	bool out_of_range(const T& value) const {
+	constexpr bool out_of_range(const T& value) const {
 		// TODO: Subtle gotcha here! Range test in contains() doesn't include maximum!
 		return !contains(value);
 	}

sdcard/PLAYLIST.TXT

@@ -0,0 +1,3 @@
+##FREQ      FILE				 SAMPLE RATE
+315000000,SAMPLES/TeslaChargePort_US.C16,500000
+433920000,SAMPLES/TeslaChargePort_EU_AU.C16,500000