Files
picogus/sw/system/flash_settings.h
T

120 lines
3.1 KiB
C

/*
* Copyright (C) 2022-2024 Ian Scott
*
* 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 of the License, 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; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
#pragma once
#ifdef __cplusplus
extern "C" {
#endif
#include <stdint.h>
#include <stdbool.h>
#define SETTINGS_MAGIC 0x70677573 // "pgus" in ascii
#define SETTINGS_VERSION 5
// When adding new fields to Settings struct:
// 1. Increment SETTINGS_VERSION
// 2. Add new fields to the struct (including in padding/holes if there's room)
// 3. Update defaultSettings in flash_settings.c with default values
// 4. Add FieldInfo entries in flash_settings.c for the new fields
// This allows preserving existing settings during upgrades
// Settings struct has generous padding for future settings by aligning to 4 bytes
typedef struct Settings {
uint32_t magic; // should be "pgus" in ascii (0x70677573)
uint8_t version;
uint8_t startupMode;
struct {
uint8_t waveTableVolume;
} Global;
struct {
uint16_t basePort;
} Joy;
struct {
uint16_t basePort;
uint8_t audioBuffer;
uint8_t dmaInterval;
bool force44k : 1;
} GUS;
struct {
uint16_t basePort;
uint16_t oplBasePort;
bool oplSpeedSensitive : 1;
} SB;
struct {
uint16_t basePort;
bool delaySysex : 1;
bool fakeAllNotesOff : 1;
} MPU;
struct {
uint16_t basePort;
} CMS;
struct {
uint16_t basePort;
} Tandy;
struct {
uint16_t basePort;
uint8_t protocol;
uint8_t reportRate;
int16_t sensitivity;
} Mouse;
struct {
uint16_t basePort;
} NE2K;
struct {
char ssid[33];
char password[64];
} WiFi;
struct {
uint16_t basePort;
bool autoAdvance : 1;
} CD;
struct {
uint16_t basePort;
} MMB;
struct {
uint8_t mainVol;
uint8_t oplVol;
uint8_t sbVol;
uint8_t cdVol;
uint8_t gusVol;
uint8_t psgVol;
} Volume;
struct {
uint8_t irq;
uint8_t dma;
uint8_t sbType;
union {
struct {
uint8_t fixTC : 1;
uint8_t lockMixer : 2;
};
uint8_t options;
};
} SB16; // TEMPORARY - may be changed!
} Settings;
void loadSettings(Settings* settings, bool migrate);
void saveSettings(const Settings* settings);
void getDefaultSettings(Settings* settings);
#ifdef __cplusplus
}
#endif