Skip to content

make SCI registers readable #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CelliesProjects wants to merge 3 commits into
base: master
Choose a base branch
from
+16 −12
Open

make SCI registers readable #119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
22434a3
make SCI registers readable
CelliesProjects Mar 14, 2026
b550ecc
Make function name camelCase
CelliesProjects Mar 14, 2026
75c967e
Added SCI_HDAT0 and SCI_HDAT1 register definition
CelliesProjects Mar 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/VS1053.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ VS1053::VS1053(uint8_t _cs_pin, uint8_t _dcs_pin, uint8_t _dreq_pin)
: cs_pin(_cs_pin), dcs_pin(_dcs_pin), dreq_pin(_dreq_pin) {
}

uint16_t VS1053::read_register(uint8_t _reg) const {
uint16_t VS1053::readRegister(uint8_t _reg) const {
uint16_t result;

control_mode_on();
Expand Down Expand Up @@ -103,7 +103,7 @@ void VS1053::wram_write(uint16_t address, uint16_t data) {

uint16_t VS1053::wram_read(uint16_t address) {
writeRegister(SCI_WRAMADDR, address); // Start reading from WRAM
return read_register(SCI_WRAM); // Read back result
return readRegister(SCI_WRAM); // Read back result
}

bool VS1053::testComm(const char *header) {
Expand Down Expand Up @@ -133,8 +133,8 @@ bool VS1053::testComm(const char *header) {

for (i = 0; (i < 0xFFFF) && (cnt < 20); i += delta) {
writeRegister(SCI_VOL, i); // Write data to SCI_VOL
r1 = read_register(SCI_VOL); // Read back for the first time
r2 = read_register(SCI_VOL); // Read back a second time
r1 = readRegister(SCI_VOL); // Read back for the first time
r2 = readRegister(SCI_VOL); // Read back a second time
if (r1 != r2 || i != r1 || i != r2) // Check for 2 equal reads
{
LOG("VS1053 error retry SB:%04X R1:%04X R2:%04X\n", i, r1, r2);
Expand Down Expand Up @@ -253,7 +253,7 @@ void VS1053::stopSong() {
writeRegister(SCI_MODE, _BV(SM_SDINEW) | _BV(SM_CANCEL));
for (i = 0; i < 200; i++) {
sdi_send_fillers(32);
modereg = read_register(SCI_MODE); // Read status
modereg = readRegister(SCI_MODE); // Read status
if ((modereg & _BV(SM_CANCEL)) == 0) {
sdi_send_fillers(2052);
LOG("Song stopped correctly after %d msec\n", i * 10);
Expand Down Expand Up @@ -303,7 +303,7 @@ void VS1053::printDetails(const char *header) {
LOG("REG Contents\n");
LOG("--- -----\n");
for (i = 0; i <= SCI_num_registers; i++) {
regbuf[i] = read_register(i);
regbuf[i] = readRegister(i);
}
for (i = 0; i <= SCI_num_registers; i++) {
delay(5);
Expand Down Expand Up @@ -365,7 +365,7 @@ void VS1053::enableI2sOut(VS1053_I2S_RATE i2sRate) {
* @return true if the chip is wired up correctly
*/
bool VS1053::isChipConnected() {
uint16_t status = read_register(SCI_STATUS);
uint16_t status = readRegister(SCI_STATUS);

return !(status == 0 || status == 0xFFFF);
}
Expand All @@ -376,7 +376,7 @@ bool VS1053::isChipConnected() {
* 5 for VS1033, 7 for VS1103, and 6 for VS1063.
*/
uint16_t VS1053::getChipVersion() {
uint16_t status = read_register(SCI_STATUS);
uint16_t status = readRegister(SCI_STATUS);

return ( (status & 0x00F0) >> 4);
}
Expand All @@ -402,7 +402,7 @@ uint16_t VS1053::getChipVersion() {
* @return current decoded time in full seconds
*/
uint16_t VS1053::getDecodedTime() {
return read_register(SCI_DECODE_TIME);
return readRegister(SCI_DECODE_TIME);
}

/**
Expand All @@ -429,7 +429,7 @@ void VS1053::adjustRate(long ppm2) {
writeRegister(SCI_WRAMADDR, 0x5b1c);
writeRegister(SCI_WRAM, 0);
// Write to AUDATA or CLOCKF checks rate and recalculates adjustment.
writeRegister(SCI_AUDATA, read_register(SCI_AUDATA));
writeRegister(SCI_AUDATA, readRegister(SCI_AUDATA));
}

/**
Expand Down
8 changes: 6 additions & 2 deletions src/VS1053.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ class VS1053 {
const uint8_t SCI_AUDATA = 0x5;
const uint8_t SCI_WRAM = 0x6;
const uint8_t SCI_WRAMADDR = 0x7;
const uint8_t SCI_HDAT0 = 0x08;
const uint8_t SCI_HDAT1 = 0x09;
const uint8_t SCI_AIADDR = 0xA;
const uint8_t SCI_VOL = 0xB;
const uint8_t SCI_AICTRL0 = 0xC;
Expand Down Expand Up @@ -113,8 +115,6 @@ class VS1053 {
SPI.endTransaction(); // Allow other SPI users
}

uint16_t read_register(uint8_t _reg) const;

void sdi_send_buffer(uint8_t *data, size_t len);

void sdi_send_fillers(size_t length);
Expand Down Expand Up @@ -201,6 +201,10 @@ class VS1053 {
// A low level method which lets users access the internals of the VS1053.
void writeRegister(uint8_t _reg, uint16_t _value) const;

// Reads from the VS10xx's SCI (serial command interface) SPI bus.
// A low level method which lets users access the internals of the VS1053.
uint16_t readRegister(uint8_t _reg) const;

// Load a patch or plugin to fix bugs and/or extend functionality.
// For more info about patches see http://www.vlsi.fi/en/support/software/vs10xxpatches.html
void loadUserCode(const unsigned short* plugin, unsigned short plugin_size);
Expand Down