Integrate SGU-1 chip support

Author: smokku

CMakeLists.txt

@@ -53,7 +53,7 @@ add_executable(emu
     src/ui/ui_app_log.cc
     src/ui/ui_x65.cc
     src/util/ringbuffer.c
-    ext/firmware/src/audio/snd/su.c
+    ext/firmware/src/audio/snd/sgu.c
     ${CMAKE_CURRENT_BINARY_DIR}/version.c
 )
 target_link_libraries(emu

ext/firmware

@@ -16,25 +16,23 @@
 /* move bit into first position */
 #define SGU1_BIT(val, bitnr) ((val >> bitnr) & 1)
 
-#define SGU1_CHIP_CLOCK (48000)  // 48kHz
-
 void sgu1_init(sgu1_t* sgu, const sgu1_desc_t* desc) {
     CHIPS_ASSERT(sgu && desc);
     CHIPS_ASSERT(desc->tick_hz > 0);
     memset(sgu, 0, sizeof(*sgu));
     sgu->sample_mag = desc->magnitude;
-    sgu->tick_period = (desc->tick_hz * SGU1_FIXEDPOINT_SCALE) / SGU1_CHIP_CLOCK;
+    sgu->tick_period = (desc->tick_hz * SGU1_FIXEDPOINT_SCALE) / SGU_CHIP_CLOCK;
     sgu->tick_counter = sgu->tick_period;
-    SoundUnit_Init(&sgu->su, 65536);
+    SGU_Init(&sgu->sgu, 65536);
 }
 
 void sgu1_reset(sgu1_t* sgu) {
     CHIPS_ASSERT(sgu);
-    SoundUnit_Reset(&sgu->su);
-    memset(sgu->reg, 0, sizeof(sgu->reg));
+    SGU_Reset(&sgu->sgu);
     sgu->tick_counter = sgu->tick_period;
     sgu->sample[0] = sgu->sample[1] = 0.0f;
     sgu->pins = 0;
+    sgu->selected_channel = 0;
 }
 
 /* tick the sound generation, return true when new sample ready */
@@ -45,13 +43,13 @@ static uint64_t _sgu1_tick(sgu1_t* sgu, uint64_t pins) {
     while (sgu->tick_counter <= 0) {
         sgu->tick_counter += sgu->tick_period;
         int32_t l, r;
-        SoundUnit_NextSample(&sgu->su, &l, &r);
+        SGU_NextSample(&sgu->sgu, &l, &r);
         sgu->sample[0] = sgu->sample_mag * (float)l / 32767.0f;
         sgu->sample[1] = sgu->sample_mag * (float)r / 32767.0f;
         pins |= SGU1_SAMPLE;
 
-        for (uint8_t i = 0; i < SGU1_NUM_CHANNELS; i++) {
-            sgu->voice[i].sample_buffer[sgu->voice[i].sample_pos++] = (float)(SoundUnit_GetSample(&sgu->su, i));
+        for (uint8_t i = 0; i < SGU_CHNS; i++) {
+            sgu->voice[i].sample_buffer[sgu->voice[i].sample_pos++] = (float)(SGU_GetSample(&sgu->sgu, i));
             if (sgu->voice[i].sample_pos >= SGU1_AUDIO_SAMPLES) {
                 sgu->voice[i].sample_pos = 0;
             }
@@ -60,34 +58,32 @@ static uint64_t _sgu1_tick(sgu1_t* sgu, uint64_t pins) {
     return pins;
 }
 
-static inline uint8_t _sgu1_selected_channel(sgu1_t* sgu) {
-    return sgu->reg[SGU1_REG_CHANNEL_SELECT] & (SGU1_NUM_CHANNELS - 1);
-}
-
 uint8_t sgu1_reg_read(sgu1_t* sgu, uint8_t reg) {
     uint8_t data;
-    if (reg < 32) {
-        data = sgu->reg[reg];
+    if (reg == SGU_REGS_PER_CH - 1) {
+        data = sgu->selected_channel;
     }
     else {
-        uint8_t chan = _sgu1_selected_channel(sgu);
-        data = ((unsigned char*)sgu->su.chan)[chan << 5 | (reg & (SGU1_NUM_CHANNEL_REGS - 1))];
+        data = ((unsigned char*)sgu->sgu.chan)[(sgu->selected_channel % SGU_CHNS) << 6 | (reg & (SGU_REGS_PER_CH - 1))];
     }
     return data;
 }
 
 void sgu1_reg_write(sgu1_t* sgu, uint8_t reg, uint8_t data) {
-    if (reg < 32) {
-        if (reg == SGU1_REG_CHANNEL_SELECT) {
-            sgu->reg[reg] = data;
-        }
+    if (reg == SGU_REGS_PER_CH - 1) {
+        sgu->selected_channel = data;
     }
     else {
-        uint8_t chan = _sgu1_selected_channel(sgu);
-        ((unsigned char*)sgu->su.chan)[chan << 5 | (reg & (SGU1_NUM_CHANNEL_REGS - 1))] = data;
+        // ((unsigned char*)sgu->sgu.chan)[(sgu->selected_channel % SGU_CHNS) << 6 | (reg & (SGU_REGS_PER_CH - 1))] =
+        // data;
+        SGU_Write(&sgu->sgu, (uint16_t)((sgu->selected_channel % SGU_CHNS) << 6) | (reg & (SGU_REGS_PER_CH - 1)), data);
     }
 }
 
+void sgu1_direct_reg_write(sgu1_t* sgu, uint16_t reg, uint8_t data) {
+    SGU_Write(&sgu->sgu, reg, data);
+}
+
 /* read a register */
 static uint64_t _sgu1_read(sgu1_t* sgu, uint64_t pins) {
     uint8_t reg = pins & SGU1_ADDR_MASK;

src/chips/sgu1.c

@@ -45,7 +45,7 @@
 #include <speex_resampler.h>
 #include <stdint.h>
 #include <stdbool.h>
-#include "snd/su.h"
+#include "snd/sgu.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -96,79 +96,6 @@ extern "C" {
 #define SGU1_CS        (1ULL << SGU1_PIN_CS)
 #define SGU1_SAMPLE    (1ULL << SGU1_PIN_SAMPLE)
 
-#define SGU1_NUM_CHANNELS     (8)
-#define SGU1_NUM_CHANNEL_REGS (32)
-
-// control registers
-#define SGU1_REG_CHANNEL_SELECT (0x00)
-
-// channel registers
-#define SGU1_CHAN_FREQ_LO         (0x00)
-#define SGU1_CHAN_FREQ_HI         (0x01)
-#define SGU1_CHAN_VOL             (0x02)
-#define SGU1_CHAN_PAN             (0x03)
-#define SGU1_CHAN_FLAGS0          (0x04)
-#define SGU1_CHAN_FLAGS1          (0x05)
-#define SGU1_CHAN_CUTOFF_LO       (0x06)
-#define SGU1_CHAN_CUTOFF_HI       (0x07)
-#define SGU1_CHAN_DUTY            (0x08)
-#define SGU1_CHAN_RESON           (0x09)
-#define SGU1_CHAN_PCMPOS_LO       (0x0A)
-#define SGU1_CHAN_PCMPOS_HI       (0x0B)
-#define SGU1_CHAN_PCMBND_LO       (0x0C)
-#define SGU1_CHAN_PCMBND_HI       (0x0D)
-#define SGU1_CHAN_PCMRST_LO       (0x0E)
-#define SGU1_CHAN_PCMRST_HI       (0x0F)
-#define SGU1_CHAN_SWFREQ_SPEED_LO (0x10)
-#define SGU1_CHAN_SWFREQ_SPEED_HI (0x11)
-#define SGU1_CHAN_SWFREQ_AMT      (0x12)
-#define SGU1_CHAN_SWFREQ_BOUND    (0x13)
-#define SGU1_CHAN_SWVOL_SPEED_LO  (0x14)
-#define SGU1_CHAN_SWVOL_SPEED_HI  (0x15)
-#define SGU1_CHAN_SWVOL_AMT       (0x16)
-#define SGU1_CHAN_SWVOL_BOUND     (0x17)
-#define SGU1_CHAN_SWCUT_SPEED_LO  (0x18)
-#define SGU1_CHAN_SWCUT_SPEED_HI  (0x19)
-#define SGU1_CHAN_SWCUT_AMT       (0x1A)
-#define SGU1_CHAN_SWCUT_BOUND     (0x1B)
-#define SGU1_CHAN_SPECIAL1C       (0x1C)
-#define SGU1_CHAN_SPECIAL1D       (0x1D)
-#define SGU1_CHAN_RESTIMER_LO     (0x1E)
-#define SGU1_CHAN_RESTIMER_HI     (0x1F)
-
-// channel control bits
-#define SGU1_FLAGS0_WAVE_SHIFT    (0)
-#define SGU1_FLAGS0_WAVE_MASK     (0x7 << SGU1_FLAGS0_WAVE_SHIFT)
-#define SGU1_FLAGS0_PCM_SHIFT     (3)
-#define SGU1_FLAGS0_PCM_MASK      (0x1 << SGU1_FLAGS0_PCM_SHIFT)
-#define SGU1_FLAGS0_CONTROL_SHIFT (4)
-#define SGU1_FLAGS0_CONTROL_MASK  (0xF << SGU1_FLAGS0_CONTROL_SHIFT)
-#define SGU1_FLAGS0_CTL_RING_MOD  (1 << 4)
-#define SGU1_FLAGS0_CTL_NSLOW     (1 << 5)
-#define SGU1_FLAGS0_CTL_NSHIGH    (1 << 6)
-#define SGU1_FLAGS0_CTL_NSBAND    (1 << 7)
-
-#define SGU1_FLAGS0_WAVE_PULSE          (0)
-#define SGU1_FLAGS0_WAVE_SAWTOOTH       (1)
-#define SGU1_FLAGS0_WAVE_SINE           (2)
-#define SGU1_FLAGS0_WAVE_TRIANGLE       (3)
-#define SGU1_FLAGS0_WAVE_NOISE          (4)
-#define SGU1_FLAGS0_WAVE_PERIODIC_NOISE (5)
-#define SGU1_FLAGS0_WAVE_XOR_SINE       (6)
-#define SGU1_FLAGS0_WAVE_XOR_TRIANGLE   (7)
-
-#define SGU1_FLAGS1_PHASE_RESET        (1 << 0)
-#define SGU1_FLAGS1_FILTER_PHASE_RESET (1 << 1)
-#define SGU1_FLAGS1_PCM_LOOP           (1 << 2)
-#define SGU1_FLAGS1_TIMER_SYNC         (1 << 3)
-#define SGU1_FLAGS1_FREQ_SWEEP         (1 << 4)
-#define SGU1_FLAGS1_VOL_SWEEP          (1 << 5)
-#define SGU1_FLAGS1_CUT_SWEEP          (1 << 6)
-
-#define SGU1_VOL_SWEEP_INC    (1 << 5)
-#define SGU1_VOL_SWEEP_WRAP   (1 << 6)
-#define SGU1_VOL_SWEEP_BOUNCE (1 << 7)
-
 #define SGU1_AUDIO_CHANNELS (2)
 #define SGU1_AUDIO_SAMPLES  (1024)
 
@@ -180,10 +107,9 @@ typedef struct {
 
 // tsu instance state
 typedef struct {
-    int sound_hz;
     // sound unit instance
-    SoundUnit su;
-    uint8_t reg[32];
+    struct SGU sgu;
+    uint8_t selected_channel;
     int tick_period;
     int tick_counter;
     // sample generation state
@@ -193,7 +119,7 @@ typedef struct {
     struct {
         int sample_pos;
         float sample_buffer[SGU1_AUDIO_SAMPLES];
-    } voice[SGU1_NUM_CHANNELS];
+    } voice[SGU_CHNS];
     // debug inspection
     uint64_t pins;
 } sgu1_t;
@@ -208,6 +134,7 @@ uint64_t sgu1_tick(sgu1_t* sgu, uint64_t pins);
 // for use by debugger
 uint8_t sgu1_reg_read(sgu1_t* sgu, uint8_t reg);
 void sgu1_reg_write(sgu1_t* sgu, uint8_t reg, uint8_t data);
+void sgu1_direct_reg_write(sgu1_t* sgu, uint16_t reg, uint8_t data);
 
 #ifdef __cplusplus
 }  // extern "C"

src/chips/sgu1.h

@@ -38,7 +38,7 @@ void x65_init(x65_t* sys, const x65_desc_t* desc) {
     sys->joystick_type = desc->joystick_type;
     sys->debug = desc->debug;
     sys->audio.callback = desc->audio.callback;
-    sys->audio.num_samples = _X65_DEFAULT(desc->audio.num_samples, X65_DEFAULT_AUDIO_SAMPLES) * X65_AUDIO_CHANNELS;
+    sys->audio.num_samples = _X65_DEFAULT(desc->audio.num_samples, X65_DEFAULT_AUDIO_SAMPLES) * SGU_AUDIO_CHANNELS;
     CHIPS_ASSERT(sys->audio.num_samples <= X65_MAX_AUDIO_SAMPLES);
 
     // initialize the hardware

src/systems/x65.c

@@ -50,7 +50,6 @@ extern "C" {
 #define X65_FREQUENCY             (3140000)  // clock frequency in Hz
 #define X65_MAX_AUDIO_SAMPLES     (2048)     // max number of audio samples in internal sample buffer
 #define X65_DEFAULT_AUDIO_SAMPLES (512)      // default number of samples in internal sample buffer
-#define X65_AUDIO_CHANNELS        (2)        // stereo output
 
 // X65 joystick types
 typedef enum {