aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/gaudio/vs1053/gaudio_play_vs1053.c
blob: 2aab288c1e9362ccf66a0f8fcfe0f5ec4dfab2e3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
/*
 * This file is subject to the terms of the GFX License. If a copy of
 * the license was not distributed with this file, you can obtain one at:
 *
 *              http://ugfx.org/license.html
 */

#include "gfx.h"

#if GFX_USE_GAUDIO && GAUDIO_NEED_PLAY

/* Include the driver defines */
#include "../../../src/gaudio/gaudio_driver_play.h"

/* Include the vs1053 registers */
#include "vs1053.h"

/* Include the board interface */
#include "gaudio_play_board.h"

// Override-able parameters
#ifndef VS1053_CLK
	#define VS1053_CLK		12288000
#endif
#ifndef VS1053_FIRMWARE_PATCH
	#define VS1053_FIRMWARE_PATCH		FALSE
#endif
#ifndef VS1053_POLL_RATE
	#define	VS1053_POLL_RATE	5
#endif

// Load the patch file if desired. New format patches only.
#if VS1053_FIRMWARE_PATCH
	#define SKIP_PLUGIN_VARNAME
	static const uint16_t plugin[] = { /* Compressed plugin */
		#include "vs1053_patch.plg"
	};
#endif

// Set various stuff based on the clock
#if VS1053_CLK >= 16192000
	#define	SCI_MODE_STARTUP	(SCI_MODE_DEFAULTS|SM_CLK_RANGE)
	#define VS1053_CLKI			(VS1053_CLK/2)
#else
	#define	SCI_MODE_STARTUP	(SCI_MODE_DEFAULTS)
	#define VS1053_CLKI			(VS1053_CLK)
#endif
#if VS1053_CLKI > 13000000 || VS1053_CLKI < 12000000
	#error "GAUDIO(vs1053): VS1053_CLK is out of range"
#endif
#if VS1053_CLKI == 12288000
	#define	SC_FREQ_ADJUST		0x0000
#else
	#define	SC_FREQ_ADJUST		((VS1053_CLKI-8000000)/4000)
#endif
#define VS1053_MAX_SAMPLE_RATE	(VS1053_CLKI/256)
#if VS1053_CLKI > 1228800
	#define SC_CLOCK_MODE		(SC_MULT_3|SC_ADD_1|SC_FREQ_ADJUST)
#else
	#define SC_CLOCK_MODE		(SC_MULT_3_5|SC_ADD_1|SC_FREQ_ADJUST)
#endif

// Our static variables
static bool_t	vs1053_isinit;
static GTimer	playTimer;

// Some common macro's
#define waitforready()		while(!board_dreq()) gfxSleepMilliseconds(5)

static void cmd_write(uint16_t addr, uint16_t data) {
	char	buf[4];
	buf[0] = 2;
	buf[1] = (char)addr;
	buf[2] = (char)(data >> 8);
	buf[3] = (char)data;

	waitforready();
	board_startcmdwrite();
	board_spiwrite(buf, 4);
	board_endcmdwrite();
}

#if VS1053_CLK > 12288000
	static GFXINLINE void cmd_writenodreq(uint16_t addr, uint16_t data) {
		uint8_t	buf[4];

		// This is the same as cmd_write() except for it doesn't wait for dreq first
		buf[0] = 2;
		buf[1] = (uint8_t)addr;
		buf[2] = (uint8_t)(data >> 8);
		buf[3] = (uint8_t)data;

		board_startcmdwrite();
		board_spiwrite(buf, 4);
		board_endcmdwrite();
	}
#endif

static uint16_t cmd_read(uint16_t addr) {
	uint8_t	buf[2];

	buf[0] = 3;
	buf[1] = (char)addr;

	board_startcmdread();
	board_spiwrite(buf, 2);
	board_spiread(buf, 2);
	board_endcmdread();
	return (((uint16_t)buf[0])<<8)|buf[1];
}

static void data_write(const uint8_t *data, unsigned len) {
	board_startdatawrite();
	board_spiwrite(data, len);
	board_enddatawrite();
}

#if VS1053_FIRMWARE_PATCH
	static void LoadUserCode(void) {
		int			i;
		uint16_t	addr, n, val;

		for(i=0; i<sizeof(plugin)/sizeof(plugin[0]);) {
			addr = plugin[i++];
			n = plugin[i++];
			if (n & 0x8000U) { /* RLE run, replicate n samples */
				n &= 0x7FFF;
				val = plugin[i++];
				while (n--)
					cmd_write(addr, val);
			} else {           /* Copy run, copy n samples */
				while (n--)
					cmd_write(addr, plugin[i++]);
			}
		}
	}
#endif

static void vs1053_hard_reset(void) {
	gtimerInit(&playTimer);

	board_init();
	board_reset();

	#if VS1053_CLK > 12288000
		cmd_writenodreq(SCI_MODE, SCI_MODE_STARTUP);	// Set super-clock before dreq
	#endif

	// Set up registers
	cmd_write(SCI_MODE, SCI_MODE_STARTUP);			// Set mode
	cmd_write(SCI_CLOCKF, SC_CLOCK_MODE);			// Set clocks
	board_init_end();								// Clocks are now set up
	cmd_write(SCI_BASS, 0x0000);					// No treble or bass boost
	cmd_write(SCI_VOL, VOL_MAX);					// Maximum volume

	// Load any firmware
	#if VS1053_FIRMWARE_PATCH
		LoadUserCode();

		// Reset mode just in case
		cmd_write(SCI_MODE, SCI_MODE_STARTUP);
	#endif
}

static void vs1053_soft_reset(void) {
	cmd_write(SCI_MODE, cmd_read(SCI_MODE)|SM_RESET);
	gfxSleepMilliseconds(1);	// Wait for at least 2uS
	waitforready();

	// Reload any firmware
	#if VS1053_FIRMWARE_PATCH
		LoadUserCode();

		// Reset mode just in case
		cmd_write(SCI_MODE, SCI_MODE_STARTUP);
	#endif
}

static uint16_t vs1053_getendbyte(void) {
	cmd_write(SCI_WRAMADDR, WRAMADDR_EXTRAPARAMS+4);
	return cmd_read(SCI_WRAM);
}

static GTimer			playTimer;
static GDataBuffer		*pplay;
static size_t			playlen;
static uint8_t			*pdata;

static void FeedData(void *param) {
	unsigned	len;
	(void)		param;

	// While there is data space
	while (board_dreq()) {

		// Send up to 32 bytes
		len = playlen;
		if (len > 32) len = 32;
		data_write(pdata, len);
		pdata += len;
		playlen -= len;

		// Have we finished the buffer
		while (!playlen) {
			gfxSystemLock();
			gaudioPlayReleaseDataBlockI(pplay);

			// Get a new data buffer
			if (!(pplay = gaudioPlayGetDataBlockI())) {
				// We should really only do the play-done when the audio
				// has really finished playing. Unfortunately there seems
				// to be no documented way of determining this.
				gaudioPlayDoneI();
				gfxSystemUnlock();
				gtimerStop(&playTimer);
				return;
			}

			// Set up ready for the new buffer
			playlen = pplay->len;
			pdata = (uint8_t *)(pplay+1);
			gfxSystemUnlock();
		}
	}
}

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

bool_t gaudio_play_lld_init(uint16_t channel, uint32_t frequency, ArrayDataFormat format) {
	uint32_t	brate;
	uint32_t	bps;
	uint8_t		buf[4];
	static const uint8_t hdr1[] = {
			'R', 'I', 'F', 'F',
			0xFF, 0xFF, 0xFF, 0xFF,
			'W', 'A', 'V', 'E',
			'f', 'm', 't', ' ',
			16, 0, 0, 0,
			0x01, 0x00,
	};
	static const uint8_t hdr2[] = {
			'd', 'a', 't', 'a',
			0xFF, 0xFF, 0xFF, 0xFF,
	};

	if (format != ARRAY_DATA_8BITUNSIGNED && format != ARRAY_DATA_16BITSIGNED && format != ARRAY_DATA_UNKNOWN)
		return FALSE;
	if (frequency > VS1053_MAX_SAMPLE_RATE)
		return FALSE;

	// Reset the chip if needed
	if (!vs1053_isinit) {
		vs1053_hard_reset();
		vs1053_isinit = TRUE;
	}

	// Setup
	if (format == ARRAY_DATA_8BITUNSIGNED || format == ARRAY_DATA_16BITSIGNED) {
		bps = (gfxSampleFormatBits(format)+7)/8;
		if (channel == GAUDIO_PLAY_STEREO)
			bps *= 2;
		brate = frequency * bps;

		// Write the RIFF header
		waitforready();
		data_write(hdr1, sizeof(hdr1));
		buf[0] = channel == GAUDIO_PLAY_STEREO ? 2 : 1;		buf[1] = 0;								data_write(buf, 2);
		buf[0] = frequency;	buf[1] = frequency>>8;	buf[2] = frequency>>16; buf[3] = frequency>>24;	data_write(buf, 4);
		buf[0] = brate;		buf[1] = brate>>8;		buf[2] = brate>>16;		buf[3] = brate>>24;		data_write(buf, 4);
		waitforready();						// 32 bytes max before checking
		buf[0] = bps; 										buf[1] = 0;								data_write(buf, 2);
		buf[0] = gfxSampleFormatBits(format);				buf[1] = 0;								data_write(buf, 2);
		data_write(hdr2, sizeof(hdr2));
	}
	return TRUE;
}

bool_t gaudio_play_lld_set_volume(uint8_t vol) {
	uint16_t tmp;

	// Volume is 0xFE -> 0x00. Adjust vol to match
	vol = ~vol;
	if (vol > 0xFE)
		vol = 0xFE;

	tmp  = 0;
	tmp |= (( vol << VOL_LEFT_SHIFT ) & VOL_LEFT_MASK );
	tmp |= (( vol << VOL_RIGHT_SHIFT ) & VOL_RIGHT_MASK );

	cmd_write(SCI_VOL, tmp);

	return TRUE;
}

void gaudio_play_lld_start(void) {

	gfxSystemLock();
	// Get a new data buffer
	if (pplay || !(pplay = gaudioPlayGetDataBlockI())) {
		gfxSystemUnlock();			// Nothing to do
		return;
	}

	// Set up ready for the new buffer
	playlen = pplay->len;
	pdata = (uint8_t *)(pplay+1);
	gfxSystemUnlock();

	// Start the playing by starting the timer and executing FeedData immediately just to get things started
	// We really should set the timer to be equivalent to half the available data but that is just too hard to calculate.
	gtimerStart(&playTimer, FeedData, 0, TRUE, VS1053_POLL_RATE);
	FeedData(0);
}

void gaudio_play_lld_stop(void) {
	uint8_t		ch;
	unsigned	i;

	// Stop the timer interrupt
	gtimerStop(&playTimer);

	// We may need to clean up the remaining buffer.
	gfxSystemLock();
	if (pplay) {
		gaudioPlayReleaseDataBlockI(pplay);
		pplay = 0;
		gaudioPlayDoneI();
	}
	gfxSystemUnlock();

	// Set CANCEL
	cmd_write(SCI_MODE, cmd_read(SCI_MODE)|SM_CANCEL);

	// Write up to 2048 bytes of data
	ch = 0;
	for(i = 0; i < 2048; i++) {
		if (!(i & 0x1F)) {
			waitforready();
			if (!(cmd_read(SCI_MODE) & SM_CANCEL))
				break;
		}
		data_write(&ch, 1);
	}

	// Make sure the cancel worked
	waitforready();
	if ((cmd_read(SCI_MODE) & SM_CANCEL))
		vs1053_soft_reset();

	// Send the terminating data
	ch = vs1053_getendbyte();
	for(i = 0; i < 2052; i++) {
		if (!(i & 0x1F))
			waitforready();
		data_write(&ch, 1);
	}
}

#endif /* GFX_USE_GAUDIO && GAUDIO_NEED_PLAY */