Use the VS1053b chip - Revision history

1BitFeverDreams: /* Registers in the FPGA that interface to the VS1053b chip */

2025-11-08T21:46:19Z

Registers in the FPGA that interface to the VS1053b chip

@@ Line 28: / Line 28: @@
 |-
 | FIFO Count 2 || 0xD705 || Second byte of the remaining byte count in the FIFO
 |}
@@ Line 42: / Line 46: @@
 |-
 | 0x3 || RW || CLOCKF|| Clock freq + multiplier
 |}

1BitFeverDreams: /* How to use the VS1053b chip */ better overview description at the top

2025-03-11T16:54:32Z

How to use the VS1053b chip: better overview description at the top

← Older revision		Revision as of 12:54, 11 March 2025
Line 5:		Line 5:

	You may have to enable its audio output via manipulation of the CODEC. Check the [[Use the CODEC]] page to see how.		You may have to enable its audio output via manipulation of the CODEC. Check the [[Use the CODEC]] page to see how.

			==== Usage for this chip ====

			* Play these types of audio files: MP3, Ogg Vorbis, WAV PCM + ADPCM audio decoding, AAC, WMA, MIDI
			* React to real time MIDI commands as an alternative to the [[SAM2695]]
			* Receive specialized plugins from the [https://www.vlsi.fi/en/support/software.html VLSI website] to increase features and apply bug patches, such as the real time spectrum analyzer, accessible through ram address using its SCI bus.

	=== Registers in the FPGA that interface to the VS1053b chip ===		=== Registers in the FPGA that interface to the VS1053b chip ===

1BitFeverDreams at 16:22, 11 March 2025

2025-03-11T16:22:42Z

← Older revision		Revision as of 12:22, 11 March 2025
Line 154:		Line 154:
	To send midi bytes to the VS1053b, use register 0xDDB1 just like you would use 0xDDA1 for the SAM2695.		To send midi bytes to the VS1053b, use register 0xDDB1 just like you would use 0xDDA1 for the SAM2695.

	==== Example C code to do a mp3 playback ====		=== Example C code to do a mp3 playback ===

	Check out this source code on Mu0n's F256KSimpleCdoodles repo:		Check out this source code on Mu0n's F256KSimpleCdoodles repo:

	https://github.com/Mu0n/F256KsimpleCdoodles/blob/main/mp3/src/mp3.c		https://github.com/Mu0n/F256KsimpleCdoodles/blob/main/mp3/src/mp3.c

1BitFeverDreams: link to datasheet

2025-03-11T16:22:18Z

link to datasheet

← Older revision		Revision as of 12:22, 11 March 2025
Line 2:		Line 2:

	====== This chip is only present in the F256K2 or the F256Jr2. It isn't available on the earlier F256K nor the F256Jr. ======		====== This chip is only present in the F256K2 or the F256Jr2. It isn't available on the earlier F256K nor the F256Jr. ======
			The datasheet can be found in this goodies github repo: https://github.com/Mu0n/F256MiscGoodies/blob/main/datasheets/VS1053B.pdf

	You may have to enable its audio output via manipulation of the CODEC. Check the [[Use the CODEC]] page to see how.		You may have to enable its audio output via manipulation of the CODEC. Check the [[Use the CODEC]] page to see how.

1BitFeverDreams: /* Boosting the Clock speed of the VS1053b */

2025-03-02T18:12:28Z

Boosting the Clock speed of the VS1053b

← Older revision		Revision as of 14:12, 2 March 2025
Line 40:		Line 40:

	After extensive perusing of the real time midi mode, as well as the mp3 playback mode, boosting the clock speed away from the default one at power up is definitely needed.		After extensive perusing of the real time midi mode, as well as the mp3 playback mode, boosting the clock speed away from the default one at power up is definitely needed.
	Here is the Clock frequency changing command that needs to be populated
	inside the 0xD702 and 0xD703 registers (SCI_DATA).		Here is the Clock frequency changing command that needs to be populated inside the 0xD702 and 0xD703 registers (SCI_DATA).

	The following 2 tables are from the datasheet that can be gotten from here: from the [https://github.com/Mu0n/F256MiscGoodies/tree/main/datasheets VS1053b Datasheet] on p.42		The following 2 tables are from the datasheet that can be gotten from here: from the [https://github.com/Mu0n/F256MiscGoodies/tree/main/datasheets VS1053b Datasheet] on p.42
Line 47:		Line 47:
	! Bit field !! 15 !! 14 !! 13 !! 12 !! 11 !! 10 !! 9 !! 8 !! 7 !! 6 !! 5 !! 4 !! 3 !! 2 !! 1 !! 0		! Bit field !! 15 !! 14 !! 13 !! 12 !! 11 !! 10 !! 9 !! 8 !! 7 !! 6 !! 5 !! 4 !! 3 !! 2 !! 1 !! 0
	\|-		\|-
	\| Purpose \|\| M3 \|\| M2 \|\| M1 \|\| A1 \|\| A0 \|\| ~~F11~~ \|\| F9 \|\| F8 \|\| F7 \|\| F6 \|\| F5 \|\| F4 \|\| F3 \|\| F2 \|\| F1 \|\| F0		\| Purpose \|\| M3 \|\| M2 \|\| M1 \|\| A1 \|\| A0 \|\| F10 \|\| F9 \|\| F8 \|\| F7 \|\| F6 \|\| F5 \|\| F4 \|\| F3 \|\| F2 \|\| F1 \|\| F0
	\|-		\|-
	\|}		\|}

1BitFeverDreams: /* Example C code to do a playback */

2025-03-02T18:09:48Z

Example C code to do a playback

← Older revision		Revision as of 14:09, 2 March 2025
Line 153:		Line 153:
	To send midi bytes to the VS1053b, use register 0xDDB1 just like you would use 0xDDA1 for the SAM2695.		To send midi bytes to the VS1053b, use register 0xDDB1 just like you would use 0xDDA1 for the SAM2695.

	==== Example C code to do a playback ====		==== Example C code to do a mp3 playback ====

	Check out this source code on Mu0n's F256KSimpleCdoodles repo:		Check out this source code on Mu0n's F256KSimpleCdoodles repo:

	https://github.com/Mu0n/F256KsimpleCdoodles/blob/main/mp3/src/mp3.c		https://github.com/Mu0n/F256KsimpleCdoodles/blob/main/mp3/src/mp3.c

1BitFeverDreams: Big cleanup, mp3 info. better tables

2025-03-02T18:09:16Z

Big cleanup, mp3 info. better tables

Show changes

1BitFeverDreams: enabling the real time midi mode and using it

2025-02-16T08:25:03Z

enabling the real time midi mode and using it

← Older revision		Revision as of 04:25, 16 February 2025
Line 1:		Line 1:
			== How to use the VS1053b chip ==

	====== This chip is only present in the F256K2 or the F256Jr2. It isn't available on the earlier F256K nor the F256Jr. ======		====== This chip is only present in the F256K2 or the F256Jr2. It isn't available on the earlier F256K nor the F256Jr. ======
	~~Massive cleanup has to be done, code has to be tried.~~
	~~Here's an info dump straight from discord~~

			You may have to enable its audio output via manipulation of the CODEC. Check the [[Use the CODEC]] page to see how.

			=== Using the real time midi mode ===

			To enable the real time midi mode (ie playing notes on a keyboard and having the VS1053b react to data sent to its FIFO buffer), it first has to be enable via the SCI bus of the chip.

			{\| class="wikitable"
			! Register Name !! Address !! Purpose
			\|-
			\| SCI Control\|\| 0xD700 \|\| Control the flow of information
			\|-
			\| SCI Address \|\| 0xD701 \|\| Select to which VS1053b address to write to
			\|-
			\| SCI Data 1 \|\| 0xD702 \|\| First byte of data
			\|-
			\| SCI Data 2 \|\| 0xD703 \|\| Second byte of data
			\|-
			\| FIFO Stat 1 \|\| 0xD704 \|\| First byte of status
			\|-
			\| FIFO Stat 2 \|\| 0xD705 \|\| Second byte of status
			\|}

			Next, you have to send this plugin data from VLSI, the makers of this chip, which contains some RLE compression. Here it is in C array form:

			<code>const uint16_t plugin[28] = { /* Compressed plugin for the VS1053b to enable real time midi mode */
			0x0007, 0x0001, 0x8050, 0x0006, 0x0014, 0x0030, 0x0715, 0xb080, /* 0 */
			0x3400, 0x0007, 0x9255, 0x3d00, 0x0024, 0x0030, 0x0295, 0x6890, /* 8 */
			0x3400, 0x0030, 0x0495, 0x3d00, 0x0024, 0x2908, 0x4d40, 0x0030, /* 10 */
			0x0200, 0x000a, 0x0001, 0x0050
			};
			</code>

			In order to properly prepare the SCI bus of the chip, this piece of code can be used with the plugin array:

			<code>void initVS1053MIDI(void) {
			uint8_t n;
			uint16_t addr, val, i=0;
			while (i<sizeof(plugin)/sizeof(plugin[0])) {
			addr = plugin[i++];
			n = plugin[i++];
			if (n & 0x8000) { /* RLE run, replicate n samples */
			n &= 0x7FFF;
			val = plugin[i++];
			while (n--) {
			//WriteVS10xxRegister(addr, val);
			POKE(VS_SCI_ADDR,addr);
			POKEW(VS_SCI_DATA,val);
			POKE(VS_SCI_CTRL,1);
			POKE(VS_SCI_CTRL,0);
			while (PEEK(VS_SCI_CTRL) & 0x80);
			}
			} else { /* Copy run, copy n samples */
			while (n--) {
			val = plugin[i++];
			//WriteVS10xxRegister(addr, val);
			POKE(VS_SCI_ADDR,addr);
			POKEW(VS_SCI_DATA,val);
			POKE(VS_SCI_CTRL,1);
			POKE(VS_SCI_CTRL,0);

			while (PEEK(VS_SCI_CTRL) & 0x80);
			}
			}
			}
			}
			</code>

			To send midi bytes to the VS1053b, use register 0xDDB1 just like you would use 0xDDA1 for the SAM2695.

			==== huge discord note infodump that has to be cleaned and understood ====
	normally, let's assume we begin with a playback of a MP3, you read the file and you will need to dump like a 2K in before it tells you to stop. But, the FIFO inside the FPGA is also 2K, so in theory before things get ugly, you can upload in the MP3 playback system 2K+2K bytes, which ought to be enough to get it going. Now, if you monitor the FPGA FIFO info when empty you can put more in. Normally, after the VS1053 queue is full, it only need 32 bytes at the time and the FPGA takes care of that. Now, basically need to make sure the FPGA FIFO is topped off. Now, when come to end, you will need to fill extra bytes with 00 to empty the VS1053 Fifo and then the tune will end.		normally, let's assume we begin with a playback of a MP3, you read the file and you will need to dump like a 2K in before it tells you to stop. But, the FIFO inside the FPGA is also 2K, so in theory before things get ugly, you can upload in the MP3 playback system 2K+2K bytes, which ought to be enough to get it going. Now, if you monitor the FPGA FIFO info when empty you can put more in. Normally, after the VS1053 queue is full, it only need 32 bytes at the time and the FPGA takes care of that. Now, basically need to make sure the FPGA FIFO is topped off. Now, when come to end, you will need to fill extra bytes with 00 to empty the VS1053 Fifo and then the tune will end.

1BitFeverDreams: added a line to inform of which machine this chip is part of

2024-11-17T04:30:36Z

added a line to inform of which machine this chip is part of

← Older revision		Revision as of 00:30, 17 November 2024
Line 1:		Line 1:
			====== This chip is only present in the F256K2 or the F256Jr2. It isn't available on the earlier F256K nor the F256Jr. ======
	Massive cleanup has to be done, code has to be tried.		Massive cleanup has to be done, code has to be tried.
	Here's an info dump straight from discord		Here's an info dump straight from discord

Foenix: Try to make things a bit cleater

2024-11-14T11:29:00Z

Try to make things a bit cleater

← Older revision		Revision as of 07:29, 14 November 2024
Line 10:		Line 10:
	This is in a nutshell the process to playback stuff.		This is in a nutshell the process to playback stuff.
	Here is the Register File Details for the VS1053 interface:		Here is the Register File Details for the VS1053 interface:

	$D700..$D707		$D700..$D707
	~~always @ (*) begin~~
	case( CPU_A_i[2:0] )		case( CPU_A_i[2:0] )
	3'b000: begin CPU_D_o = {Busy, VS1053B_Registers[0][6:0]}; end		3'b000: begin CPU_D_o = {Busy, VS1053B_Registers[0][6:0]}; end
Line 22:		Line 23:
	3'b111: begin CPU_D_o = 8'h00; end		3'b111: begin CPU_D_o = 8'h00; end
	endcase		endcase
	~~end~~

	// VS1053B_Registers[0] - Bit Fields: ($D700..$D703)		'''VS1053B_Registers[0] - Bit Fields: ($D700..$D703)'''
	// [0] 1: Start Transfer
	// [1] 1: Read Register, 0: Write Register		[0] 1: Start Transfer
	// [7] 1: SPI Transfer in Progress [Busy]
	// VS1053B_Registers[1]		[1] 1: Read Register, 0: Write Register
	// [3:0] Register to Access
			[7] 1: SPI Transfer in Progress [Busy]

			'''VS1053B_Registers[1]'''

			[3:0] Register to Address

			'''VS1053B_Registers[2] Data Access Low'''

	~~// VS1053B_Registers[2] Data Access Low~~		'''VS1053B_Registers[3] Data Access Hi'''
	// VS1053B_Registers[3] Data Access Hi

	There are 2 Accessible Area for the VS1053		There are 2 Accessible Area for the VS1053