Added stable release pipeline (#573)

* Fixed no audio issue v2 (#567)

.github/workflows/create_stable_release.yml

@@ -0,0 +1,93 @@
+name: Stable Release
+
+on:    
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Get current date
+        id: date
+        run: echo "::set-output name=date::$(date +'%Y-%m-%d')"
+      - name: Checkout 
+        uses: actions/checkout@master
+        with:
+          fetch-depth: 0
+          ref: next
+          submodules: true
+      - name: Git Sumbodule Update
+        run: |
+          git submodule update --init --recursive
+      - name: Get version
+        id: version
+        run: echo "::set-output name=version::$(cat .github/workflows/version.txt)"
+      - name: Get past version
+        id: past_version
+        run: echo "::set-output name=past_version::$(cat .github/workflows/past_version.txt)"
+      - name: Build the Docker image
+        run: docker build -t portapack-dev -f dockerfile-nogit . --tag my-image-name:$(date +%s)
+      - name: Make build folder
+        run: mkdir ${{ github.workspace }}/build
+      - name: Run the Docker image
+        run: docker run -e VERSION_STRING=${{ steps.version.outputs.version }} -i -v ${{ github.workspace }}:/havoc portapack-dev
+      - name: Create Firmware ZIP
+        run: |
+          zip -j firmware.zip build/firmware/portapack-h1_h2-mayhem.bin && cd flashing && zip -r ../firmware.zip *
+      - name: Create SD Card ZIP
+        run: |
+          zip -r sdcard.zip sdcard
+      - name: Create changelog
+        run: |
+          CHANGELOG=$(python3 .github/workflows/stable_changelog.py ${{ steps.past_version.outputs.past_version }})
+          CHANGELOG="${CHANGELOG//'%'/'%25'}"
+          CHANGELOG="${CHANGELOG//$'\n'/'%0A'}"
+          CHANGELOG="${CHANGELOG//$'\r'/'%0D'}"
+          echo "::set-output name=content::$CHANGELOG"
+        id: changelog
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: v1.5.1
+          release_name: Mayhem firmware ${{ steps.version.outputs.version }}
+          body: |
+            **Stable release - ${{ steps.version.outputs.version }}**
+            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/). Please check the [readme](https://github.com/eried/portapack-mayhem/blob/master/README.md) for details.
+            ## Release notes
+            ###  Revision (${{ steps.version.outputs.version }}):
+            ${{ steps.changelog.outputs.content }}
+            
+            **Full Changelog**: https://github.com/eried/portapack-mayhem/compare/${{ steps.past_version.outputs.past_version }}...${{ steps.version.outputs.version }}
+
+            ## Installation
+            Check the [wiki](https://github.com/eried/portapack-havoc/wiki/Update-firmware) for details how to upgrade. 
+
+            ### MicroSD card files
+
+            For certain functionality, like the world map, GPS simulator, and others you need to uncompress (using [7-zip](https://www.7-zip.org/download.html)) the files from `mayhem_vX.Y.Z_COPY_TO_SDCARD.zip` to a FAT32 formatted MicroSD card.
+          draft: true
+          prerelease: false
+      - name: Upload Firmware Asset
+        id: upload-firmware-asset 
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./firmware.zip
+          asset_name: mayhem_${{ steps.version.outputs.version }}_FIRMWARE.zip
+          asset_content_type: application/zip
+      - name: Upload SD Card Assets
+        id: upload-sd-card-asset 
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: ${{ steps.create_release.outputs.upload_url }}
+          asset_path: ./sdcard.zip
+          asset_name: mayhem_${{ steps.version.outputs.version }}_COPY_TO_SDCARD.zip
+          asset_content_type: application/zip
+     

.github/workflows/past_version.txt

@@ -0,0 +1 @@
+v1.5.0

.github/workflows/stable_changelog.py

@@ -0,0 +1,30 @@
+import os
+import re
+import sys
+
+past_version = sys.argv[1]
+
+raw_git = os.popen('git log ' + past_version + '..next --pretty=format:"- %h - {USERNAME}*+%al-%an*: %s"').read()
+
+
+def compute_username(line):
+    stripped = re.search(r'(?<=\*)(.*?)(?=\*)', line).group(0)
+
+    pattern = re.compile("[$@+&?].*[$@+&?]")
+    if pattern.match(stripped):
+        stripped = re.sub("[$@+&?].*[$@+&?]", "", stripped)
+        stripped = re.match(r'.+?(?=-)', stripped).group(0)
+    else:
+        stripped = re.sub(r'^.*?-', "", stripped)
+    return "@" + stripped
+
+
+def compile_line(line):
+    username = compute_username(line)
+    line = re.sub(r'[*].*[*]', "", line)
+    line = line.replace("{USERNAME}", username)
+    return line
+
+
+for row in raw_git.splitlines():
+    print(compile_line(row))

.github/workflows/version.txt

@@ -0,0 +1 @@
+v1.5.1

firmware/application/main.cpp

@@ -167,7 +167,7 @@ int main(void) {
 	if( portapack::init() ) {
 		portapack::display.init();
 
-		sdcStart(&SDCD1, nullptr);
+		// sdcStart(&SDCD1, nullptr); // Commented out as now happens in portapack.cpp
 
 		// controls_init(); // Commented out as now happens in portapack.cpp
 		lcd_frame_sync_configure();
@@ -175,6 +175,7 @@ int main(void) {
 
 		event_loop();
 
+
 		sdcDisconnect(&SDCD1);
 		sdcStop(&SDCD1);
 

firmware/application/portapack.cpp

@@ -48,6 +48,10 @@ using asahi_kasei::ak4951::AK4951;
 #include "optional.hpp"
 #include "irq_controls.hpp"
 
+#include "file.hpp" 
+#include "sd_card.hpp"
+#include "string_format.hpp"
+
 namespace portapack {
 
 portapack::IO io {
@@ -177,14 +181,84 @@ enum class PortaPackModel {
 	R2_20170522,
 };
 
+static bool save_config(int8_t value){
+	persistent_memory::set_config_cpld(value);
+	if(sd_card::status() == sd_card::Status::Mounted){
+		make_new_directory("/hardware"); 
+		File file;
+		auto sucess = file.create("/hardware/settings.txt");
+		if(!sucess.is_valid()) {
+			file.write_line(to_string_dec_uint(value));
+		}
+	}
+	return true;
+}
+
+int read_file(std::string name) {
+	std::string return_string = "";
+	File file;
+	auto success = file.open(name);
+
+	if(!success.is_valid()) {
+		char one_char[1];
+		for(size_t pointer = 0; pointer < file.size() ; pointer++) {
+			file.seek(pointer);
+			file.read(one_char, 1);
+			return_string += one_char[0];
+		}
+		return std::stoi(return_string);
+	} 
+	return -1; 
+}
+
+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){
+			int data = read_file("/hardware/settings.txt");
+			if(data != -1) {
+				config_value = data;
+			}
+		} else {
+			config_value = value;
+		}
+	}
+	return config_value.value();
+}
+
+
 static PortaPackModel portapack_model() {
 	static Optional<PortaPackModel> model;
 
 	if( !model.is_valid() ) {
-		if( audio_codec_wm8731.detected() ) {
-			model = PortaPackModel::R1_20150901; // H1R1
+		const auto switches_state = get_switches_state();
+		if (switches_state[(size_t)ui::KeyEvent::Up]){
+			save_config(1);
+			model = PortaPackModel::R2_20170522;
+		}
+		else if (switches_state[(size_t)ui::KeyEvent::Down]){
+			save_config(2);
+			model = PortaPackModel::R1_20150901;
+		}
+		else if (switches_state[(size_t)ui::KeyEvent::Left]){
+			save_config(3);
+		}
+		else if (switches_state[(size_t)ui::KeyEvent::Select]){
+			save_config(0);
+		}
+		
+
+		if (load_config() == 1) {
+			model = PortaPackModel::R2_20170522;
+		} else if (load_config() == 2) {
+			model = PortaPackModel::R1_20150901;
 		} else {
-			model = PortaPackModel::R2_20170522; // H1R2, H2+
+			if( audio_codec_wm8731.detected() ) {
+				model = PortaPackModel::R1_20150901; // H1R1
+			} else {
+				model = PortaPackModel::R2_20170522; // H1R2, H2, H2+
+			}
 		}
 	}
 
@@ -203,28 +277,6 @@ static audio::Codec* portapack_audio_codec() {
 }
 
 static const portapack::cpld::Config& portapack_cpld_config() {
-	const auto switches_state = get_switches_state();
-	if (switches_state[(size_t)ui::KeyEvent::Up]){
-		persistent_memory::set_config_cpld(1);
-		return portapack::cpld::rev_20170522::config;
-	}
-	if (switches_state[(size_t)ui::KeyEvent::Down]){
-		persistent_memory::set_config_cpld(2);
-		return portapack::cpld::rev_20150901::config;
-	}
-	if (switches_state[(size_t)ui::KeyEvent::Left]){
-		persistent_memory::set_config_cpld(3);
-	}
-	if (switches_state[(size_t)ui::KeyEvent::Select]){
-		persistent_memory::set_config_cpld(0);
-	}
-	
-
-	if (portapack::persistent_memory::config_cpld() == 1) {
-		return portapack::cpld::rev_20170522::config;
-	} else if (portapack::persistent_memory::config_cpld() == 2) {
-		return portapack::cpld::rev_20150901::config;
-	}
 	return (portapack_model() == PortaPackModel::R2_20170522)
 			? portapack::cpld::rev_20170522::config
 			: portapack::cpld::rev_20150901::config;
@@ -408,17 +460,17 @@ bool init() {
 	clock_manager.enable_first_if_clock();
 	clock_manager.enable_second_if_clock();
 	clock_manager.enable_codec_clocks();
-	radio::init();	
+	radio::init();
+
+	sdcStart(&SDCD1, nullptr);
+	sd_card::poll_inserted();
+	
+	chThdSleepMilliseconds(1);
 
 	if( !portapack::cpld::update_if_necessary(portapack_cpld_config()) ) {
+		chThdSleepMilliseconds(1);
 		// If using a "2021/12 QFP100", press and hold the left button while booting. Should only need to do once.
-		const auto switches_state = get_switches_state();
-		/*
-		 * The LEFT key held check seems redundant as its in the portapack_cpld_config().
-		 * But for some reason the persistent_memory check fails on some devices if we dont have the extra check in....
-		 * So dont ask me why that is, but we have to keep this redundant check in for the persistent_memory check to work.
-		 */
-		if (!switches_state[(size_t)ui::KeyEvent::Left] && portapack::persistent_memory::config_cpld() != 3){
+		if (load_config() != 3){
 			shutdown_base();
 			return false;
 		}
@@ -428,10 +480,13 @@ bool init() {
 		chSysHalt();
 	}
 
+	chThdSleepMilliseconds(1); // This delay seems to solve white noise audio issues
+
 	LPC_CREG->DMAMUX = portapack::gpdma_mux;
 	gpdma::controller.enable();
 
 	audio::init(portapack_audio_codec());
+	
 
 	return true;
 }