Merge remote-tracking branch 'origin/release/1.0' into feature/optimi…

…zeDivision

.github/workflows/beta-build.yml

@@ -5,7 +5,7 @@ on:
   push:
     branches:
       - 'release/1.0'  
-  pull_request:
+  pull_request_target:
     types:
       - closed
     branches:

.vscode/launch.json

@@ -17,13 +17,36 @@
       "request": "launch",
       "cwd": "${workspaceRoot}",
       "executable": "${workspaceRoot}/build/Debug/deluge.elf",
+      "windows": {
+        "serverpath": "C:\\Program Files\\SEGGER\\JLink\\JLinkGDBServerCL.exe", 
+      },
       "servertype": "jlink",
       "device": "R7S721020",
       "interface": "swd",
-      "runToEntryPoint": "main",
+      //"runToEntryPoint": "main",
       "svdFile": "${workspaceRoot}/contrib/rza1.svd",
+      "overrideLaunchCommands": [
+        "monitor reset",
+        "load"
+      ],
+      "overrideResetCommands": [
+        "monitor reset",
+        "load"
+      ],
+      "overrideRestartCommands": [
+        "monitor reset",
+        "load"
+      ],
       "rttConfig": {
         "enabled": true,
+        "address": "auto",
+        "decoders": [
+          {
+            "port": 0,
+            "timestamp": true,
+            "type": "console"
+          }
+        ]
       },
     },
     {
@@ -54,8 +77,11 @@
       "MIMode": "gdb",
       "miDebuggerPath": "arm-none-eabi-gdb",
       "windows": {
-        "miDebuggerPath": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb.exe"
+        "miDebuggerPath": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb.exe",
+        "debugServerPath": "C:/Program Files/SEGGER/JLink/JLinkGDBServerCL.exe",
       },
+      "debugServerArgs": "-select USB -device R7S721020 -endian little -if SWD -speed auto -noir -LocalhostOnly -nologtofile -port 3333 -SWOPort 2332 -TelnetPort 2333",
+      "serverStarted": "Connected to target",
       "linux": {
         "miDebuggerPath": "${workspaceRoot}/toolchain/linux-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb"
       },
@@ -75,8 +101,11 @@
       "MIMode": "gdb",
       "miDebuggerPath": "arm-none-eabi-gdb",
       "windows": {
-        "miDebuggerPath": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb.exe"
+        "miDebuggerPath": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb.exe",
+        "debugServerPath": "C:/Program Files/SEGGER/JLink/JLinkGDBServerCL.exe",
       },
+      "debugServerArgs": "-select USB -device R7S721020 -endian little -if SWD -speed auto -noir -LocalhostOnly -nologtofile -port 3333 -SWOPort 2332 -TelnetPort 2333",
+      "serverStarted": "Connected to target",
       "linux": {
         "miDebuggerPath": "${workspaceRoot}/toolchain/linux-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb"
       },
@@ -115,8 +144,11 @@
       "MIMode": "gdb",
       "miDebuggerPath": "arm-none-eabi-gdb",
       "windows": {
-        "miDebuggerPath": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb.exe"
+        "miDebuggerPath": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb.exe",
+        "debugServerPath": "C:/Program Files/SEGGER/JLink/JLinkGDBServerCL.exe",
       },
+      "debugServerArgs": "-select USB -device R7S721020 -endian little -if SWD -speed auto -noir -LocalhostOnly -nologtofile -port 3333 -SWOPort 2332 -TelnetPort 2333",
+      "serverStarted": "Connected to target",
       "linux": {
         "miDebuggerPath": "${workspaceRoot}/toolchain/linux-x86_64/arm-none-eabi-gcc/bin/arm-none-eabi-gdb"
       },
@@ -151,7 +183,7 @@
       "type": "lldb",
       "request": "launch",
       "targetCreateCommands": [
-        "target create ${workspaceFolder}/build/debug/deluge7SEG.elf"
+        "target create ${workspaceFolder}/build/Debug/deluge.elf"
       ],
       "processCreateCommands": [
         "gdb-remote localhost:3333"

.vscode/settings.json

@@ -15,4 +15,5 @@
         "SDRAM",
         "Synthstrom"
     ],
+    "cortex-debug.armToolchainPath.windows": "${workspaceRoot}/toolchain/win32-x86_64/arm-none-eabi-gcc/bin",
 }

CMakeLists.txt

@@ -48,6 +48,7 @@ execute_process(
 string(TIMESTAMP DATE_TODAY "%Y.%m.%d")
 
 # Build our version string
+set(BUILD_COMMIT_SHORT "${GIT_COMMIT_SHORT}") # Used in firmware
 set(BUILD_VERSION_STRING "${PROJECT_VERSION}${SEMVER_PRERELEASE_ID}-${GIT_COMMIT_SHORT}") # Used in firmware
 set(BUILD_VERSION_SUFFIX "-v${PROJECT_VERSION}${SEMVER_PRERELEASE_ID}+${DATE_TODAY}-${GIT_COMMIT_SHORT}") # Used for filename
 
@@ -125,8 +126,8 @@ add_compile_options(
     -fdiagnostics-parseable-fixits
     -fsigned-char
 
-    # Debug symbols
-    $<$<CONFIG:DEBUG,RELWITHDEBINFO>:-ggdb3> # Include
+    # Debug symbols, also for release so we get a full ELF
+    $<$<CONFIG:DEBUG,RELEASE,RELWITHDEBINFO>:-ggdb3> # Include
 
     # Optimization level
     $<$<CONFIG:DEBUG>:-Og>
@@ -215,7 +216,8 @@ target_link_options(deluge PUBLIC
     LINKER:--gc-sections
     LINKER:--entry=start # Set the entrypoint to 'start' (see RZA1/compiler/asm/start.S)
 
-    $<$<CONFIG:RELEASE>:LINKER:--strip-all> # Strip
+    # Enabled to generate a full ELF, objcopy will do the stripping
+    # $<$<CONFIG:RELEASE>:LINKER:--strip-all> # Strip
 
     -nostartfiles # Don't emit startfiles
 

docs/community_features.md

@@ -38,6 +38,16 @@ Here is a list of general improvements that have been made, ordered from newest
 #### 3.7 - Mod Wheel
 - ([#512]) Incoming mod wheel on non-MPE synths now maps to y axis
 
+#### 3.8 - Visual Feedback on Value Changes with Mod Encoders and Increased Resolution for Value's in Menu's
+- ([#636]) Changing parameter values with Mod (Gold) Encoders now displays a pop-up with the current value of the Parameter. The Menu's for Parameters and Patch Cables have also been adjusted to show the same value range as displayed with the Mod Encoders.
+	- This allows for better fine-tuning of values. 
+	- The value range displayed is 0-50 for non-MIDI parameters and 0-127 for MIDI parameters.
+	- Note: In the Menu, if you wish to scroll through the parameter value range faster at an accelerated rate of +/- 5, hold Shift while turning the Select Encoder.
+
+#### 3.9 - Adjust Metronome Volume
+- ([#683]) The Metronome's volume now respects the song's volume and will increase and decrease in volume together with the Gold Volume Encoder.
+	- In addition, a Default menu was created titled "Metronome" which enables you to set a value between 22 and 27 to further adjust the volume of the Metronome. 22 being the lowest metronome volume that can be heard when the Song's volume is at its maximum and 27 being the loudest metronome volume.
+
 ## 4. New Features Added
 
 Here is a list of features that have been added to the firmware as a list, grouped by category:
@@ -58,7 +68,6 @@ Here is a list of features that have been added to the firmware as a list, group
     - Default (DEFA) - the default Deluge clip type.
 	- Fill (FILL) - Fill clip. It appears orange/cyan on the status pads, and when triggered it will schedule itself to start at such a time that it _finishes_ at the start of the next loop. If the fill clip is longer than the remaining time, it is triggered immediately at a point midway through. The loop length is set by the longest playing clip, or by the total length of a section times the repeat count set for that section. **Limitation**: a fill clip is still subject to the one clip per instrument behavior of the Deluge. Fill clips can steal an output from another fill, but they cannot steal from a non-fill. This can lead to some fills never starting since a default type clip has the needed instrument. This can be worked around by cloning the instrument to an independent copy.
 
-
 #### 4.1.4 - Catch Notes
 
  - ([#221]) The normal behavior of the Deluge is to try to keep up with 'in progress' notes when instant switching between clips by playing them late. However this leads to glitches with drum clips and other percussive sounds. Changing this setting to OFF will prevent this behavior and *not* try to keep up with those notes, leading to smoother instant switching between clips.
@@ -74,7 +83,12 @@ Here is a list of features that have been added to the firmware as a list, group
 	 - Compared to rows layout overdub recording and copying clips to arranger is currently not supported
 	 - Every track (column) has a random generated color that can be changed in edit mode (see below)
 	 - Launched clips are full color, unlaunched dimmed and during soloing all non soloed clips are greyed out
-	 - A new menu to select the default Layout has been added in Shift+Selection Encoder -> Defaults -> UI -> Song -> Layout
+	 - New default settings that can be reached with Shift+Selection Encoder -> Defaults -> UI -> Song
+		- Layout: Select the default layout for all new songs
+		- Grid
+			- Default active mode: "Selection" allows changing the mode as described below, all other settings will always make mode snap back to the configured one (default Selection)
+			- Select in green mode: Enabling this will make allow holding clips in green (launch) mode to change their parameters like in blue mode, tradeoff is arming is executed on finger up (default on)
+			- Empty pad unarm: Enabling will make pressing empty pads in a track unarm all playing tracks in that track (default off)
 	 - There are different interaction modes that change how the grid behaves
 		- The mode can be changed by clicking on one of the colored pads in the Audition/Section column on the right
 		- To permanently switch the mode click on a pad and release, to temporarily switch hold the mode pad and use the grid, the mode will snap back to the current permanent one
@@ -197,6 +211,11 @@ Synchronization modes accessible through the "LFO SYNC" shortcut.
  - Follow-up PR's: 
 	- ([#347]) Added new automatable parameters
  	- ([#360]) Fixed interpolation bugs, added fine tuning for long presses, and added pad selection mode
+	- ([#636]) Updated Parameter Values displayed in Automation View to match Parameter Value Ranges displayed in the Menu's. E.g. instead of 0 - 128, it now displays 0 - 50 (except for Pan which now displays -25 to +25 and MIDI instrument clips which now display 0 - 127).
+	- ([#681]) Added new automation community feature menu to re-instate audition pad shortcuts in the Automation Instrument Clip View.
+		- Currently in the Instrument Clip View if you hold down an audition pad and press a shortcut pad on the grid, it will open the menu corresponding to that shortcut pad.
+		- By default in the Automation Instrument Clip View that same behaviour of holding an audition pad and pressing a shortcut pad is disabled in favour of you being able to hold down an audition pad and adjust the automation lane values so that you can audible hear the changes to the sound while adjusting automation settings.
+		- Through the community features menu, you can disable this change and re-instate the audition pad shortcuts by setting the community feature to "Off."
 
 #### 4.3.6 - Set Probability By Row
 
@@ -307,6 +326,12 @@ In the main menu of the deluge (accessed by pressing "SHIFT" + the "SELECT" knob
 	* Shift Note (SHIF)
 		* When On, shifting notes horizontally in the regular Instrument Clip View will shift the Notes and MPE, but not the Automation.
 		* When On, to shift Non-MPE Automation horizontally you will need to enter the Automation Instrument Clip View.
+	* Disable Audition Pad Shortcuts (SCUT)
+		* When On, audition pad shortcuts are disabled. Holding an audition pad and pressing a shortcut pad will not activate the shortcut and will not change the selected parameter.
+		* When On, to change the selected parameter you will need to either: 
+			1) use the select encoder; 
+			2) use the shift + shortcut pad combo; or
+			3) go back to the automation overview;
 * Allow Insecure Develop Sysex Messages (SYX)
   	* When On, the ability to load firmware over USB is enabled.
 * Sync Scaling Action (SCAL)
@@ -352,7 +377,6 @@ This list includes all preprocessor switches that can alter firmware behaviour a
 [#122]: https://github.com/SynthstromAudible/DelugeFirmware/pull/122
 [#125]: https://github.com/SynthstromAudible/DelugeFirmware/pull/125
 [#129]: https://github.com/SynthstromAudible/DelugeFirmware/pull/129
-[#630]: https://github.com/SynthstromAudible/DelugeFirmware/pull/630
 [#138]: https://github.com/SynthstromAudible/DelugeFirmware/pull/138
 [#141]: https://github.com/SynthstromAudible/DelugeFirmware/pull/141
 [#157]: https://github.com/SynthstromAudible/DelugeFirmware/pull/157
@@ -390,4 +414,8 @@ This list includes all preprocessor switches that can alter firmware behaviour a
 [#368]: https://github.com/SynthstromAudible/DelugeFirmware/pull/368
 [#395]: https://github.com/SynthstromAudible/DelugeFirmware/pull/395
 [#512]: https://github.com/SynthstromAudible/DelugeFirmware/pull/512
+[#630]: https://github.com/SynthstromAudible/DelugeFirmware/pull/630
+[#636]: https://github.com/SynthstromAudible/DelugeFirmware/pull/636
+[#681]: https://github.com/SynthstromAudible/DelugeFirmware/pull/681
+[#683]: https://github.com/SynthstromAudible/DelugeFirmware/pull/683
 [Automation View Documentation]: https://github.com/SynthstromAudible/DelugeFirmware/blob/release/1.0/docs/features/automation_view.md

docs/features/automation_view.md

@@ -146,7 +146,9 @@ The Automation Editor **will:**
 - enable you to quickly change parameters in focus for editing by turning select or using shift + shortcut pad
 - enable you to view the current parameter value setting for the parameters that are currently automatable.
 - illuminate each pad row according to the current value within the range of 0-128. E.g. bottom pad = 0-16, then 17-32, 33-48, 49-64, 65-80, 81-96, 97-112, 113-128) 
+> **Update** The values displayed in automation view have been updated to display the same value range displayed in the menu's for consistency across the Deluge UI. So instead of displaying 0 - 128, it now displays 0 - 50. Calculations in automation view are still being done based on the 0 - 128 range, but the display converts it to the 0 - 50 range.
 - edit new or existing parameter automations on a per step basis, at any zoom level across the entire timeline. Each row in a step column corresponds to a range of values in the parameter value range (0-128) (see above). If you press the bottom row, the value will be set to 0. if you press the top row, the value will be set to 128. Pressing the rows in between increments/decrements the value by 18 (e.g. 0, 18, 36, 54, 72, 90, 108, 128). 
+> **Update** The values displayed in automation view have been updated to display the same value range displayed in the menu's for consistency across the Deluge UI. So instead of displaying 0 - 128, it now displays 0 - 50. Calculations in automation view are still being done based on the 0 - 128 range, but the display converts it to the 0 - 50 range.
 
 ![image](https://github.com/seangoodvibes/DelugeFirmware/assets/138174805/8cc7befa-9071-4bd3-ac3c-15049f69b250)
 
@@ -317,6 +319,16 @@ In the Automation Instrument Clip View, functionality is provided to shift autom
 
 > **Note:** MPE recorded will still be shifted as the scope of this PR does not cover editing MPE.
 
+### Disable Audition Pad Shortcuts
+
+Currently in the Instrument Clip View if you hold down an audition pad and press a shortcut pad on the grid, it will open the menu corresponding to that shortcut pad.
+
+By default in the Automation Instrument Clip View that same behaviour of holding an audition pad and pressing a shortcut pad is disabled in favour of you being able to hold down an audition pad and adjust the automation lane values so that you can audible hear the changes to the sound while adjusting automation settings.
+
+Through the community features menu, you can disable this change and re-instate the audition pad shortcuts by setting the community feature to "Off."
+
+> **Note:** in automation view, shortcuts do not open the menu. They change the selected parameter for automation lane editing.
+
 # Fun things to try with the new Automation Instrument Clip View
 
 ## Two Hand Automation Drumming

linker_script_rz_a1l.ld

@@ -150,6 +150,8 @@ SECTIONS
 	/* ALIGN(0x20) is only necessary for v0 bootloaders */
   	.reset : ALIGN(0x20) /* 0x10 isn't enough. Not sure why any of this is necessary though. */
 	{
+        PROVIDE(program_code_start = .);
+
 		execute = .;
 		*start.S.obj (.text)
 		*start.S.obj (.rodata)
@@ -180,6 +182,8 @@ SECTIONS
 
 		_etext = .;
 		address_end_reset = .;
+
+        PROVIDE(program_code_end = .);
 	} > RAM012L
 
 	.rodata :

src/CMakeLists.txt

@@ -1,6 +1,6 @@
 cmake_path(SET SHARED_INCLUDE ${CMAKE_CURRENT_LIST_DIR})
 
-target_sources(deluge PUBLIC main.c resetprg.c c_lib_alternatives.S)
+target_sources(deluge PUBLIC main.c resetprg.c fault_handler.c c_lib_alternatives.S)
 
 add_subdirectory(deluge)
 add_subdirectory(RZA1)