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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
|
/****************************************************************************
* drivers/audio/vs1053.c
*
* Audio device driver for VLSI Solutions VS1053 Audio codec.
*
* Copyright (C) 2013 Ken Pettit. All rights reserved.
* Author: Ken Pettit <pettitkd@gmail.com>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <sys/ioctl.h>
#include <stdint.h>
#include <stdio.h>
#include <fcntl.h>
#include <string.h>
#include <debug.h>
#include <errno.h>
#include <queue.h>
#include <nuttx/kmalloc.h>
#include <nuttx/fs/fs.h>
#include <nuttx/fs/ioctl.h>
#include <nuttx/audio/audio.h>
#include <nuttx/audio/vs1053.h>
#include <nuttx/math.h>
#include "vs1053.h"
/****************************************************************************
* Private Definitions
****************************************************************************/
#ifndef CONFIG_VS1053_SPIMODE
# define CONFIG_VS1053_SPIMODE SPIDEV_MODE0
#endif
#ifndef CONFIG_VS1053_XTALI
# define CONFIG_VS1053_XTALI 12288000
#endif
#ifndef CONFIG_VS1053_MP3_DECODE_FREQ
# define CONFIG_VS1053_MP3_DECODE_FREQ 43000000
#endif
#ifndef CONFIG_VS1053_MSG_PRIO
# define CONFIG_VS1053_MSG_PRIO 1
#endif
#ifndef CONFIG_VS1053_BUFFER_SIZE
# define CONFIG_VS1053_BUFFER_SIZE 8192
#endif
#ifndef CONFIG_VS1053_NUM_BUFFERS
# define CONFIG_VS1053_NUM_BUFFERS 2
#endif
#define VS1053_DUMMY 0xFF
#define VS1053_DEFAULT_XTALI 12288000
#define VS1053_DATA_FREQ 20000000
#define VS1053_RST_USECS 2000
/****************************************************************************
* Private Types
****************************************************************************/
struct vs1053_struct_s
{
/* We are an audio lower half driver */
struct audio_lowerhalf_s lower;
/* Our specific driver data goes here */
const FAR struct vs1053_lower_s *hw_lower;/* Pointer to the hardware lower functions */
FAR struct spi_dev_s *spi; /* Pointer to the SPI bus */
FAR struct ap_buffer_s *pBuf; /* Pointer to the buffer we are processing */
struct dq_queue_s apbq; /* Our queue for enqueued buffers */
unsigned long spi_freq; /* Frequency to run the SPI bus at. */
unsigned long chip_freq; /* Current chip frequency */
mqd_t mq; /* Message queue for receiving messages */
char mqname[16]; /* Our message queue name */
pthread_t threadid; /* ID of our thread */
sem_t apbq_sem; /* Audio Pipeline Buffer Queue sem access */
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
int16_t volume; /* Current volume level */
#ifndef CONFIG_AUDIO_EXCLUDE_BALANCE
int16_t balance; /* Current balance level */
#endif /* CONFIG_AUDIO_EXCLUDE_BALANCE */
#endif /* CONFIG_AUDIO_EXCLUDE_VOLUME */
#ifndef CONFIG_AUDIO_EXCLUDE_TONE
uint8_t bass; /* Bass level */
uint8_t treble; /* Bass level */
#endif
uint16_t endfillbytes;
uint8_t endfillchar; /* Fill char to send when no more data */
uint8_t running;
uint8_t paused;
uint8_t endmode;
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
uint8_t cancelmode;
#endif
uint8_t busy; /* Set true when device reserved */
};
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
static int vs1053_getcaps(FAR struct audio_lowerhalf_s *lower, int type,
FAR struct audio_caps_s *pCaps);
static int vs1053_shutdown(FAR struct audio_lowerhalf_s *lower);
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_configure(FAR struct audio_lowerhalf_s *lower,
FAR void *session, FAR const struct audio_caps_s *pCaps);
static int vs1053_start(FAR struct audio_lowerhalf_s *lower,
FAR void *session);
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
static int vs1053_stop(FAR struct audio_lowerhalf_s *lower,
FAR void *session);
#endif
#ifndef CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME
static int vs1053_pause(FAR struct audio_lowerhalf_s *lower,
FAR void *session);
static int vs1053_resume(FAR struct audio_lowerhalf_s *lower,
FAR void *session);
#endif /* CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME */
static int vs1053_reserve(FAR struct audio_lowerhalf_s *lower,
FAR void** ppContext);
static int vs1053_release(FAR struct audio_lowerhalf_s *lower,
FAR void* pContext);
#else
static int vs1053_configure(FAR struct audio_lowerhalf_s *lower,
FAR const struct audio_caps_s *pCaps);
static int vs1053_start(FAR struct audio_lowerhalf_s *lower);
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
static int vs1053_stop(FAR struct audio_lowerhalf_s *lower);
#endif
#ifndef CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME
static int vs1053_pause(FAR struct audio_lowerhalf_s *lower);
static int vs1053_resume(FAR struct audio_lowerhalf_s *lower);
#endif /* CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME */
static int vs1053_reserve(FAR struct audio_lowerhalf_s *lower);
static int vs1053_release(FAR struct audio_lowerhalf_s *lower);
#endif /* CONFIG_AUDIO_MULTI_SESION */
static int vs1053_enqueuebuffer(FAR struct audio_lowerhalf_s *lower,
FAR struct ap_buffer_s *apb);
static int vs1053_cancelbuffer(FAR struct audio_lowerhalf_s *lower,
FAR struct ap_buffer_s *apb);
static int vs1053_ioctl(FAR struct audio_lowerhalf_s *lower, int cmd,
unsigned long arg);
/****************************************************************************
* Private Data
****************************************************************************/
static const struct audio_ops_s g_audioops =
{
vs1053_getcaps, /* getcaps */
vs1053_configure, /* configure */
vs1053_shutdown, /* shutdown */
vs1053_start, /* start */
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
vs1053_stop, /* stop */
#endif
#ifndef CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME
vs1053_pause, /* pause */
vs1053_resume, /* resume */
#endif
NULL, /* alloc_buffer */
NULL, /* free_buffer */
vs1053_enqueuebuffer, /* enqueue_buffer */
vs1053_cancelbuffer, /* cancel_buffer */
vs1053_ioctl, /* ioctl */
NULL, /* read */
NULL, /* write */
vs1053_reserve, /* reserve */
vs1053_release /* release */
};
/* ISR context pointers */
static struct vs1053_struct_s* g_isrdata[CONFIG_VS1053_DEVICE_COUNT] = { NULL, };
/* Volume control log table. This table is in increments of 2% of
* requested volume level and is the register value that should be
* programmed to the VS1053 to achieve that volume pecentage.
*/
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
static const uint8_t g_logtable [] =
{
254, 170, 140, 122, 110, /* 0 - 8 */
100, 92, 85, 80, 74, /* 10 - 18 */
70, 66, 62, 59, 55, /* 20 - 28 */
52, 49, 47, 44, 42, /* 30 - 38 */
40, 38, 36, 34, 32, /* 40 - 48 */
30, 28, 27, 25, 24, /* 50 - 58 */
22, 21, 19, 18, 17, /* 60 - 68 */
15, 14, 13, 12, 11, /* 70 - 78 */
10, 9, 8, 7, 6, /* 80 - 88 */
5, 4, 3, 2, 1, /* 90 - 98 */
0 /* 100 */
};
#endif /* CONFIG_AUDIO_EXCLUDE_VOLUME */
/****************************************************************************
* Private Functions
****************************************************************************/
/************************************************************************************
* Name: vs1053_spi_lock
************************************************************************************/
static void vs1053_spi_lock(FAR struct spi_dev_s *dev, unsigned long freq_mhz)
{
/* On SPI busses where there are multiple devices, it will be necessary to
* lock SPI to have exclusive access to the busses for a sequence of
* transfers. The bus should be locked before the chip is selected.
*
* This is a blocking call and will not return until we have exclusiv access to
* the SPI buss. We will retain that exclusive access until the bus is unlocked.
*/
(void)SPI_LOCK(dev, true);
/* After locking the SPI bus, the we also need call the setfrequency, setbits, and
* setmode methods to make sure that the SPI is properly configured for the device.
* If the SPI buss is being shared, then it may have been left in an incompatible
* state.
*/
SPI_SETMODE(dev, CONFIG_VS1053_SPIMODE);
SPI_SETBITS(dev, 8);
(void)SPI_SETFREQUENCY(dev, freq_mhz);
}
/************************************************************************************
* Name: vs1053_spi_unlock
************************************************************************************/
static inline void vs1053_spi_unlock(FAR struct spi_dev_s *dev)
{
(void)SPI_LOCK(dev, false);
}
/************************************************************************************
* Name: vs1053_readreg - Read the specified 16-bit register from the
* VS1053 device. Caller must hold the SPI lock.
************************************************************************************/
static uint16_t vs1053_readreg(FAR struct vs1053_struct_s *dev, uint8_t reg)
{
uint16_t ret;
FAR struct spi_dev_s *spi = dev->spi;
/* Select the AUDIO_CTRL device on the SPI bus */
SPI_SELECT(spi, SPIDEV_AUDIO_CTRL, true);
/* Send the WRITE command followed by the address */
SPI_SEND(spi, VS1053_OPCODE_READ);
SPI_SEND(spi, reg);
/* Now read the 16-bit value */
ret = SPI_SEND(spi, VS1053_DUMMY) << 8;
ret |= SPI_SEND(spi, VS1053_DUMMY);
/* Deselect the CODEC */
SPI_SELECT(spi, SPIDEV_AUDIO_CTRL, false);
return ret;
}
/************************************************************************************
* Name: vs1053_writereg - Write the specified 16-bit register to the
* VS1053 device. Caller must hold the SPI lock.
************************************************************************************/
static void vs1053_writereg(FAR struct vs1053_struct_s *dev, uint8_t reg, uint16_t val)
{
FAR struct spi_dev_s *spi = dev->spi;
/* Select the AUDIO_CTRL device on the SPI bus */
audvdbg("Write Reg %d = 0x%0X\n", reg, val);
SPI_SELECT(spi, SPIDEV_AUDIO_CTRL, true);
/* Send the WRITE command followed by the address */
SPI_SEND(spi, VS1053_OPCODE_WRITE);
SPI_SEND(spi, reg);
/* Now read the 16-bit value */
SPI_SEND(spi, val >> 8);
SPI_SEND(spi, val & 0xFF);
/* Deselect the CODEC */
SPI_SELECT(spi, SPIDEV_AUDIO_CTRL, false);
/* Short delay after a write for VS1053 processing time */
usleep(10);
}
/****************************************************************************
* Name: vs1053_setfrequency
*
* Description: Get the audio device capabilities
*
****************************************************************************/
static int vs1053_setfrequency(FAR struct vs1053_struct_s *dev, uint32_t freq)
{
double factor;
uint16_t reg;
uint8_t timeout;
audvdbg("Entry\n");
/* Calculate the clock divisor based on the input frequency */
factor = (double) freq / (double) CONFIG_VS1053_XTALI * 10.0 + 0.5;
/* Check the input frequency against bounds */
if (factor > 50.0)
{
audvdbg("Frequency too high! Limiting to XTALI * 5\n");
factor = 50.0;
return -EINVAL;
}
if (factor < 10.0)
{
factor = 10.0;
}
/* Calculate the clock mulit register based on the factor */
if ((int) factor == 10)
{
reg = 0;
}
else
{
reg = (((int) factor - 15) / 5) << VS1053_SC_MULT_SHIFT;
}
/* Set the MULT_ADD factor to the max to allow the chip to dynamically
* increase the frequency the maximum amount as needed
*/
reg |= (VS1053_SC_ADD_XTALIx20 << VS1053_SC_ADD_SHIFT);
/* If we aren't running with a 12.228Mhz input crystal, then we
* must tell the chip what the frequency is
*/
if (CONFIG_VS1053_XTALI != VS1053_DEFAULT_XTALI)
{
/* Calculate register value based on equation: (XTALI - 8000000) / 4000
* per the datasheet.
*/
reg |= (CONFIG_VS1053_XTALI - 8000000) / 4000;
}
/* Now set the new clock multiplier register */
vs1053_writereg(dev, VS1053_SCI_CLOCKF, reg);
/* Wait for DREQ to go active */
timeout = 200;
while (!dev->hw_lower->read_dreq(dev->hw_lower) && timeout)
{
usleep(1000);
timeout--;
}
/* Update our internal variables */
dev->chip_freq = freq;
dev->spi_freq = freq / 7;
return OK;
}
/************************************************************************************
* Name: vs1053_logapprox - Approximate the register value in .5 dB increments
* level based on the percentage using a log table since
* math libraries aren't available.
************************************************************************************/
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
uint8_t vs1053_logapprox(int percent)
{
/* Check percentage for bounds */
if (percent >= 100)
{
return 0;
}
return (g_logtable[percent >> 1] + g_logtable[(percent+1) >> 1]) >> 1;
}
#endif /* CONFIG_AUDIO_EXCLUDE_VOLUME */
/************************************************************************************
* Name: vs1053_setvolume - Set the right and left volume values in the VS1053
* device based on the current volume and balance settings.
************************************************************************************/
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
static void vs1053_setvolume(FAR struct vs1053_struct_s *dev)
{
FAR struct spi_dev_s *spi = dev->spi;
uint32_t leftlevel;
uint32_t rightlevel;
uint8_t leftreg, rightreg;
/* Constrain balance */
#ifndef CONFIG_AUDIO_EXCLUDE_BALANCE
if (dev->balance > 1000)
{
dev->balance = 1000;
}
/* Calculate the left channel volume level */
if (dev->balance <= 500)
{
leftlevel = dev->volume;
}
else if (dev->balance == 1000)
{
leftlevel = 0;
}
else
{
leftlevel = dev->volume * (1000 - dev->balance) / 500;
}
/* Calculate the right channel volume level */
if (dev->balance >= 500)
{
rightlevel = dev->volume;
}
else if (dev->balance == 0)
{
rightlevel = 0;
}
else
{
rightlevel = dev->volume * dev->balance / 500;
}
#else
leftlevel = rightlevel = dev->volume;
#endif
/* Calculate the left and right register values */
/* The register sets the volume in dB which is a logrithmic scale,
* so we must use log() to calculate the register value.
*/
leftreg = vs1053_logapprox(leftlevel / 10);
rightreg = vs1053_logapprox(rightlevel / 10);
/* Lock the SPI bus to get exclsive access to the chip. */
vs1053_spi_lock(spi, dev->spi_freq);
vs1053_writereg(dev, VS1053_SCI_VOL, (leftreg << 8) | rightreg);
vs1053_spi_unlock(spi);
}
#endif /* CONFIG_AUDIO_EXCLUDE_VOLUME */
/************************************************************************************
* Name: vs1053_setbass - Set the bass and treble level as specified in the
* context's bass and treble variables..
*
* The level and range are in whole percentage levels (0-100).
*
************************************************************************************/
#ifndef CONFIG_AUDIO_EXCLUDE_TONE
static void vs1053_setbass(FAR struct vs1053_struct_s *dev)
{
FAR struct spi_dev_s *spi = dev->spi;
int bass_range, bass_boost;
int treble_range, treble_boost;
/* Calculate range and boost based on level */
bass_boost = 15 * dev->bass / 100;
bass_range = 15;
treble_boost = 15 * dev->treble / 100;
treble_range = 15;
/* Lock the SPI bus to get exclsive access to the chip. */
vs1053_spi_lock(spi, dev->spi_freq);
vs1053_writereg(dev, VS1053_SCI_BASS, (treble_boost << 12) | (treble_range << 8) |
(bass_boost << 4) | bass_range);
vs1053_spi_unlock(spi);
}
#endif /* CONFIG_AUDIO_EXCLUDE_TONE */
/****************************************************************************
* Name: vs1053_getcaps
*
* Description: Get the audio device capabilities
*
****************************************************************************/
static int vs1053_getcaps(FAR struct audio_lowerhalf_s *lower, int type,
FAR struct audio_caps_s *pCaps)
{
audvdbg("Entry\n");
/* Validate the structure */
DEBUGASSERT(pCaps->ac_len >= sizeof(struct audio_caps_s));
/* Fill in the caller's structure based on requested info */
pCaps->ac_format[0] = 0;
pCaps->ac_format[1] = 0;
pCaps->ac_controls[0] = 0;
pCaps->ac_controls[1] = 0;
pCaps->ac_controls[2] = 0;
pCaps->ac_controls[3] = 0;
switch (pCaps->ac_type)
{
/* Caller is querying for the types of units we support */
case AUDIO_TYPE_QUERY:
/* Provide our overall capabilities. The interfacing software
* must then call us back for specific info for each capability.
*/
pCaps->ac_channels = 2; /* Stereo output */
/* The input formats we can decode / accept */
pCaps->ac_format[0] = 0
#ifdef CONFIG_AUDIO_FORMAT_AC3
| AUDIO_FMT_AC3
#endif
#ifdef CONFIG_AUDIO_FORMAT_MP3
| AUDIO_FMT_MP3
#endif
#ifdef CONFIG_AUDIO_FORMAT_WMA
| AUDIO_FMT_WMA
#endif
#ifdef CONFIG_AUDIO_FORMAT_MIDI
| AUDIO_FMT_MIDI
#endif
#ifdef CONFIG_AUDIO_FORMAT_PCM
| AUDIO_FMT_PCM
#endif
;
#ifdef CONFIG_AUDIO_FORMAT_OGG_VORBIS
pCaps->ac_format[1] = (AUDIO_FMT_OGG_VORBIS) >> 8;
#endif
/* The types of audio units we implement */
pCaps->ac_controls[0] = AUDIO_TYPE_OUTPUT | AUDIO_TYPE_FEATURE |
AUDIO_TYPE_PROCESSING;
break;
/* Provide capabilities of our OUTPUT unit */
case AUDIO_TYPE_OUTPUT:
pCaps->ac_channels = 2;
switch (pCaps->ac_subtype)
{
case AUDIO_TYPE_QUERY:
/* Report the Sample rates we support */
pCaps->ac_controls[0] = AUDIO_SAMP_RATE_8K | AUDIO_SAMP_RATE_11K |
AUDIO_SAMP_RATE_16K | AUDIO_SAMP_RATE_22K |
AUDIO_SAMP_RATE_32K | AUDIO_SAMP_RATE_44K |
AUDIO_SAMP_RATE_48K;
break;
case AUDIO_FMT_MP3:
case AUDIO_FMT_WMA:
case AUDIO_FMT_PCM:
/* Report the Bit rates we support. The bit rate support is actually a
* complex function of the format and selected sample rate, and the datasheet
* has multiple tables to indicate the supported bit rate vs sample rate vs
* format. The selected sample rate should be provided in the ac_format
* field of the query, and only a single sample rate should be given.
*/
/* TODO: Create a table or set of tables to report this! */
break;
default:
break;
}
break;
/* Provide capabilities of our FEATURE units */
case AUDIO_TYPE_FEATURE:
/* If the sub-type is UNDEF, then report the Feature Units we support */
if (pCaps->ac_subtype == AUDIO_FU_UNDEF)
{
/* Fill in the ac_controls section with the Feature Units we have */
pCaps->ac_controls[0] = AUDIO_FU_VOLUME | AUDIO_FU_BASS | AUDIO_FU_TREBLE;
}
else
{
/* TODO: Do we need to provide specific info for the Feature Units,
* such as volume setting ranges, etc.?
*/
}
break;
/* Provide capabilities of our PROCESSING unit */
case AUDIO_TYPE_PROCESSING:
switch (pCaps->ac_subtype)
{
case AUDIO_PU_UNDEF:
/* Provide the type of Processing Units we support */
pCaps->ac_controls[0] = AUDIO_PU_STEREO_EXTENDER;
break;
case AUDIO_PU_STEREO_EXTENDER:
/* Proivde capabilities of our Stereo Extender */
pCaps->ac_controls[0] = AUDIO_STEXT_ENABLE | AUDIO_STEXT_WIDTH;
break;
default:
/* Other types of processing uint we don't support */
break;
}
break;
/* All others we don't support */
default:
/* Zero out the fields to indicate no support */
pCaps->ac_subtype = 0;
pCaps->ac_channels = 0;
break;
}
/* Return the length of the audio_caps_s struct for validation of
* proper Audio device type.
*/
return pCaps->ac_len;
}
/****************************************************************************
* Name: vs1053_configure
*
* Description: Configure the audio device for the specified mode of
* operation.
*
****************************************************************************/
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_configure(FAR struct audio_lowerhalf_s *lower,
FAR void *session, FAR const struct audio_caps_s *pCaps)
#else
static int vs1053_configure(FAR struct audio_lowerhalf_s *lower,
FAR const struct audio_caps_s *pCaps)
#endif
{
int ret = OK;
#if !defined(CONFIG_AUDIO_EXCLUDE_VOLUME) || !defined(CONFIG_AUDIO_EXCLUDE_TONE)
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
#endif
audvdbg("Entry\n");
/* Process the configure operation */
switch (pCaps->ac_type)
{
case AUDIO_TYPE_FEATURE:
/* Process based on Feature Unit */
switch (*((uint16_t *) pCaps->ac_format))
{
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
case AUDIO_FU_VOLUME:
/* Set the volume */
dev->volume = *((uint16_t *) pCaps->ac_controls);
vs1053_setvolume(dev);
break;
#endif /* CONFIG_AUDIO_EXCLUDE_VOLUME */
#if !defined(CONFIG_AUDIO_EXCLUDE_TONE) && !defined(CONFIG_AUDIO_EXCLUDE_VOLUME)
case AUDIO_FU_BALANCE:
/* Set the volume */
dev->balance = *((uint16_t *) pCaps->ac_controls);
vs1053_setvolume(dev);
break;
#endif
#ifndef CONFIG_AUDIO_EXCLUDE_TONE
case AUDIO_FU_BASS:
/* Set the bass. The percentage level (0-100) is in the
* ac_controls[0] parameter.
*/
dev->bass = pCaps->ac_controls[0];
if (dev->bass > 100)
dev->bass = 100;
vs1053_setbass(dev);
break;
case AUDIO_FU_TREBLE:
/* Set the treble. The percentage level (0-100) is in the
* ac_controls[0] parameter.
*/
dev->treble = pCaps->ac_controls[0];
if (dev->treble > 100)
dev->treble = 100;
vs1053_setbass(dev);
break;
#endif /* CONFIG_AUDIO_EXCLUDE_TONE */
default:
/* Others we don't support */
break;
}
break;
case AUDIO_TYPE_PROCESSING:
/* We only support STEREO_EXTENDER */
if (*((uint16_t *) pCaps->ac_format) == AUDIO_PU_STEREO_EXTENDER)
{
}
break;
}
return ret;
}
/****************************************************************************
* Name: vs1053_softreset
*
* Description: Performs a soft reset on the VS1053 chip by setting the
* RESET bit of the MODE register.
*
****************************************************************************/
static int vs1053_softreset(FAR struct vs1053_struct_s *dev)
{
uint16_t reg;
uint16_t timeout;
/* First disable interrupts, lower the frequency and lock the SPI bus */
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
vs1053_spi_lock(dev->spi, VS1053_DEFAULT_XTALI / 7);
/* Now issue a reset command */
reg = vs1053_readreg(dev, VS1053_SCI_MODE);
vs1053_writereg(dev, VS1053_SCI_MODE, reg | VS1053_SM_RESET);
/* Now wait for the SM_RESET to go inactive */
timeout = 1000;
while (vs1053_readreg(dev, VS1053_SCI_MODE) & VS1053_SM_RESET && timeout)
{
timeout--;
}
/* Switch to low frequency, Unlock the SPI bus and exit */
vs1053_setfrequency(dev, CONFIG_VS1053_XTALI);
vs1053_spi_unlock(dev->spi);
return OK;
}
/****************************************************************************
* Name: vs1053_hardreset
*
* Description: Performs a hardware reset on the VS1053 chip by toggling
* the RST line, disabling IRQ, and setting the default
* XTALI frequency.
*
****************************************************************************/
static int vs1053_hardreset(FAR struct vs1053_struct_s *dev)
{
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
dev->hw_lower->reset(dev->hw_lower, false);
usleep(10);
dev->hw_lower->reset(dev->hw_lower, true);
usleep(VS1053_RST_USECS);
vs1053_setfrequency(dev, CONFIG_VS1053_XTALI); /* Slow speed at first */
return OK;
}
/****************************************************************************
* Name: vs1053_shutdown
*
* Description: Shutdown the VS1053 chip and put it in the lowest power
* state possible.
*
****************************************************************************/
static int vs1053_shutdown(FAR struct audio_lowerhalf_s *lower)
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
FAR struct spi_dev_s *spi = dev->spi;
audvdbg("Entry\n");
vs1053_spi_lock(spi, dev->spi_freq); /* Lock the device */
vs1053_setfrequency(dev, CONFIG_VS1053_XTALI); /* Reduce speed to minimum */
vs1053_writereg(dev, VS1053_SCI_VOL, 0xFEFE); /* Power down the DAC outputs */
vs1053_spi_unlock(spi); /* Unlock the device */
return OK;
}
/****************************************************************************
* Name: vs1053_feeddata
*
* Description: Feeds more data to the vs1053 chip from the enqueued
* buffers. It will continue feeding data until the DREQ
* line indicates it can't accept any more data.
*
****************************************************************************/
static void vs1053_feeddata(FAR struct vs1053_struct_s *dev)
{
int bytecount;
int ret;
uint8_t *pSamp = NULL;
uint16_t reg;
struct ap_buffer_s *pBuf;
FAR struct spi_dev_s *spi = dev->spi;
/* Check for false interrupt caused by an SCI transaction */
if (!dev->hw_lower->read_dreq(dev->hw_lower) || dev->paused)
{
return;
}
/* Grab the SPI bus. We can run at 20Mhz because we increased the
* chip frequency above 40Mhz for the decode operation.
*/
vs1053_spi_lock(spi, VS1053_DATA_FREQ); /* Lock the SPI bus */
SPI_SELECT(spi, SPIDEV_AUDIO_DATA, true); /* Select the VS1053 data bus */
/* Local stack copy of our active buffer */
pBuf = dev->pBuf;
//auddbg("Entry pBuf=%p, Bytes left=%d\n", pBuf, pBuf->nbytes - pBuf->curbyte);
/* Setup pointer to the next sample in the buffer */
if (pBuf)
{
pSamp = &pBuf->samp[pBuf->curbyte];
}
else if (!dev->endmode)
{
SPI_SELECT(spi, SPIDEV_AUDIO_DATA, false);
vs1053_spi_unlock(spi);
return;
}
/* Loop until the FIFO is full */
while (dev->hw_lower->read_dreq(dev->hw_lower))
{
/* If endmode, then send fill characters */
if (dev->endmode)
{
bytecount = 32;
while (bytecount)
{
SPI_SEND(spi, dev->endfillchar);
bytecount--;
}
/* For the VS1053, after the file has been played, we must
* send 2052 bytes of endfillchar per the datasheet.
*/
dev->endfillbytes += 32;
/* Process end mode logic. We send 2080 bytes of endfillchar as
* directed by the datasheet, then set SM_CANCEL. Then we wait
* until the chip clears SM_CANCEL while sending endfillchar
* 32 bytes at a time.
*/
if (dev->endfillbytes == 32*65)
{
/* After at least 2052 bytes, we send an SM_CANCEL */
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
(void)SPI_SETFREQUENCY(dev->spi, dev->spi_freq);
reg = vs1053_readreg(dev, VS1053_SCI_MODE);
vs1053_writereg(dev, VS1053_SCI_MODE, reg | VS1053_SM_CANCEL);
dev->hw_lower->enable(dev->hw_lower); /* Enable the DREQ interrupt */
}
else if (dev->endfillbytes >= 32*130)
{
/* Do a hard reset and terminate */
vs1053_hardreset(dev);
dev->running = FALSE;
dev->endmode = FALSE;
break;
}
else if (dev->endfillbytes > 32*65)
{
/* After each 32 byte of endfillchar, check the status
* register to see if SM_CANCEL has been cleard. If
* it has been cleared, then we're done.
*/
if (!(vs1053_readreg(dev, VS1053_SCI_STATUS) & VS1053_SM_CANCEL))
{
(void)SPI_SETFREQUENCY(dev->spi, dev->spi_freq);
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
auddbg("HDAT1: 0x%0X HDAT0: 0x%0X\n",
vs1053_readreg(dev, VS1053_SCI_HDAT1),
vs1053_readreg(dev, VS1053_SCI_HDAT0));
vs1053_writereg(dev, VS1053_SCI_WRAMADDR, VS1053_END_FILL_BYTE);
dev->endfillchar = vs1053_readreg(dev, VS1053_SCI_WRAM) >> 8;
auddbg("EndFillChar: 0x%0X\n", dev->endfillchar);
reg = vs1053_readreg(dev, VS1053_SCI_MODE);
vs1053_writereg(dev, VS1053_SCI_MODE, reg | VS1053_SM_RESET);
dev->running = FALSE;
dev->endmode = FALSE;
break;
}
}
}
else
{
/* Send 32 more bytes. We only send 32 at a time because this is
* the meaning of DREQ active from the chip ... that it can
* accept at least 32 more bytes. After each 32 byte block, we
* will recheck the DREQ line again.
*/
bytecount = pBuf->nbytes - pBuf->curbyte;
if (bytecount > 32)
{
bytecount = 32;
}
#if 1
SPI_SNDBLOCK(spi, pSamp, bytecount);
pSamp += bytecount;
#else
bytecount = bytecount;
while (bytecount--)
{
/* Send next byte from the buffer */
SPI_SEND(spi, *pSamp);
pSamp++;
}
#endif
pBuf->curbyte += bytecount;
/* Test if we are in cancel mode. If we are, then we need
* to continue sending file data and check for the SM_CANCEL
* bit going inactive.
*/
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
if (dev->cancelmode)
{
/* Read the VS1053 MODE register */
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
(void)SPI_SETFREQUENCY(dev->spi, dev->spi_freq);
reg = vs1053_readreg(dev, VS1053_SCI_MODE);
(void)SPI_SETFREQUENCY(dev->spi, VS1053_DATA_FREQ);
dev->hw_lower->enable(dev->hw_lower); /* Enable the DREQ interrupt */
/* Check the SM_CANCEL bit */
if (!(reg & VS1053_SM_CANCEL))
{
/* Cancel has begun. Switch to endmode */
pBuf->curbyte = pBuf->nbytes = 0;
}
}
#endif /* CONFIG_AUDIO_EXCLUDE_STOP */
/* Test if we are at the end of the buffer */
if (pBuf->curbyte >= pBuf->nbytes)
{
if (pBuf->nbytes != pBuf->nmaxbytes)
{
/* This is the final buffer. Get the VS1053 endfillchar */
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
(void)SPI_SETFREQUENCY(dev->spi, dev->spi_freq);
vs1053_writereg(dev, VS1053_SCI_WRAMADDR, VS1053_END_FILL_BYTE);
dev->endfillchar = vs1053_readreg(dev, VS1053_SCI_WRAM) >> 8;
(void)SPI_SETFREQUENCY(dev->spi, VS1053_DATA_FREQ);
dev->hw_lower->enable(dev->hw_lower); /* Enable the DREQ interrupt */
/* Mark the device as endmode */
dev->endmode = TRUE;
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
if (dev->cancelmode)
{
/* If we are in cancel mode, then we don't dequeue the buffer
* or need to send another SM_CANCEL, so jump into the middle
* of the stop sequence.
*/
dev->endfillbytes = 32*65+1;
continue;
}
else
#endif /* CONFIG_AUDIO_EXCLUDE_STOP */
{
dev->endfillbytes = 0;
}
}
/* We referenced the buffer so we must free it */
apb_free(pBuf);
#ifdef CONFIG_AUDIO_MULTI_SESSION
dev->lower.upper(dev->lower.priv, AUDIO_CALLBACK_DEQUEUE,
pBuf, OK, NULL);
#else
dev->lower.upper(dev->lower.priv, AUDIO_CALLBACK_DEQUEUE,
pBuf, OK);
#endif
/* Lock the buffer queue to pop the next buffer */
if ((ret = sem_wait(&dev->apbq_sem)) != OK)
{
#ifdef CONFIG_AUDIO_MULTI_SESSION
dev->lower.upper(dev->lower.priv,
AUDIO_CALLBACK_IOERR, NULL, ret, NULL);
#else
dev->lower.upper(dev->lower.priv,
AUDIO_CALLBACK_IOERR, NULL, ret);
#endif
auddbg("I/O error!\n");
goto err_out;
}
/* Pop the next entry */
pBuf = (struct ap_buffer_s *) dq_remfirst(&dev->apbq);
dev->pBuf = pBuf;
//auddbg("Next Buffer = %p, bytes = %d\n", pBuf, pBuf ? pBuf->nbytes : 0);
if (pBuf == NULL)
{
sem_post(&dev->apbq_sem);
break;
}
pSamp = &pBuf->samp[pBuf->curbyte];
apb_reference(pBuf); /* Add our buffer reference */
sem_post(&dev->apbq_sem);
}
}
}
/* Deselect the SPI bus and unlock it */
err_out:
SPI_SELECT(spi, SPIDEV_AUDIO_DATA, false);
vs1053_spi_unlock(spi);
}
/****************************************************************************
* Name: vs1053_dreq_isr
*
* This is the ISR that services the DREQ pin from the VS1053, which
* indicates the chip is ready to receive additional data. We use it to
* send a message to our workertherad message queue so it knows to wake
* up and send more data.
*
****************************************************************************/
static int vs1053_dreq_isr(int irq, FAR void *context)
{
struct vs1053_struct_s *dev = NULL;
struct audio_msg_s msg;
/* Get the driver context */
#if CONFIG_VS1053_DEVICE_COUNT == 1
dev = g_isrdata[0]; /* Simple case */
#else
/* More complex case */
{
int x;
for (x = 0; x < CONFIG_VS1053_DEVICE_COUNT; x++)
{
if (g_isrdata[x]->hw_lower->irq == irq)
{
dev = g_isrdata[x];
break;
}
}
DEBUGASSERT(dev);
}
#endif
/* Now create a message and send it to the workerthread */
if (dev->running)
{
msg.msgId = AUDIO_MSG_DATA_REQUEST;
mq_send(dev->mq, &msg, sizeof(msg), CONFIG_VS1053_MSG_PRIO);
}
else
{
msg.msgId = AUDIO_MSG_DATA_REQUEST;
}
return 0;
}
/****************************************************************************
* Name: vs1053_workerthread
*
* This is the thread that feeds data to the chip and keeps the audio
* stream going.
*
****************************************************************************/
static void *vs1053_workerthread(pthread_addr_t pvarg)
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) pvarg;
struct audio_msg_s msg;
FAR struct ap_buffer_s *pBuf;
int size, prio;
uint16_t reg;
uint8_t timeout;
auddbg("Entry\n");
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
dev->cancelmode = 0;
#endif
dev->endmode = dev->endfillbytes = 0;
/* Fill the VS1053 FIFO with initial data. */
vs1053_feeddata(dev); /* Fill the VS1053 FIFO */
/* Wait for DREQ to go active so we can issue a READ command */
timeout = 200;
while (!dev->hw_lower->read_dreq(dev->hw_lower) && timeout)
{
usleep(100);
timeout--;
}
/* Loop as long as we are supposed to be running */
dev->running = TRUE;
dev->hw_lower->enable(dev->hw_lower); /* Enable the DREQ interrupt */
while (dev->running || dev->endmode)
{
if (dev->hw_lower->read_dreq(dev->hw_lower))
{
vs1053_feeddata(dev); /* Feed more data to the VS1053 FIFO */
}
/* Wait for messages from our message queue */
size = mq_receive(dev->mq, &msg, sizeof(msg), &prio);
/* Handle the case when we return with no message */
if (size == 0)
{
/* Should we just stop running? */
dev->running = FALSE;
break;
}
/* Process the message */
switch (msg.msgId)
{
/* The ISR has requested more data */
case AUDIO_MSG_DATA_REQUEST:
usleep(500);
vs1053_feeddata(dev); /* Feed more data to the VS1053 FIFO */
break;
/* Stop the playback */
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
case AUDIO_MSG_STOP:
if (!dev->hw_lower->read_dreq(dev->hw_lower))
{
usleep(300);
}
/* Send CANCEL message to VS1053 */
dev->hw_lower->disable(dev->hw_lower);
vs1053_spi_lock(dev->spi, dev->spi_freq);
reg = vs1053_readreg(dev, VS1053_SCI_MODE);
vs1053_writereg(dev, VS1053_SCI_MODE, reg | VS1053_SM_CANCEL);
vs1053_spi_unlock(dev->spi);
dev->hw_lower->enable(dev->hw_lower);
/* Set cancelmode */
dev->cancelmode = TRUE;
break;
#endif
/* We will wake up when a new buffer enqueued just in case */
case AUDIO_MSG_ENQUEUE:
break;
default:
break;
}
}
/* Disable the DREQ interrupt */
dev->hw_lower->disable(dev->hw_lower);
/* Cancel any leftover buffer in our queue */
if (sem_wait(&dev->apbq_sem) == OK)
{
/* Get the next buffer from the queue */
while ((pBuf = (FAR struct ap_buffer_s *) dq_remfirst(&dev->apbq)) != NULL)
;
}
sem_post(&dev->apbq_sem);
/* Free the active buffer */
if (dev->pBuf != NULL)
{
apb_free(dev->pBuf);
dev->pBuf = NULL;
}
/* Close the message queue */
mq_close(dev->mq);
mq_unlink(dev->mqname);
dev->mq = NULL;
/* Send an AUDIO_MSG_COMPLETE message to the client */
#ifdef CONFIG_AUDIO_MULTI_SESSION
dev->lower.upper(dev->lower.priv, AUDIO_CALLBACK_COMPLETE, NULL, OK, NULL);
#else
dev->lower.upper(dev->lower.priv, AUDIO_CALLBACK_COMPLETE, NULL, OK);
#endif
auddbg("Exit\n");
return NULL;
}
/****************************************************************************
* Name: vs1053_start
*
* Description: Start the configured operation (audio streaming, volume
* enabled, etc.).
*
****************************************************************************/
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_start(FAR struct audio_lowerhalf_s *lower, FAR void *session)
#else
static int vs1053_start(FAR struct audio_lowerhalf_s *lower)
#endif
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
struct mq_attr attr;
struct sched_param sparam;
pthread_attr_t tattr;
int ret;
void *value;
auddbg("Entry\n");
vs1053_spi_lock(dev->spi, dev->spi_freq); /* Lock the device */
auddbg("Entry HDAT1=0x%0X HDAT0=0x%0X\n",
vs1053_readreg(dev, VS1053_SCI_HDAT1),
vs1053_readreg(dev, VS1053_SCI_HDAT0));
vs1053_spi_unlock(dev->spi);
/* Do a soft reset, just in case */
vs1053_softreset(dev);
/* Increase the frequency of the part during processing */
vs1053_spi_lock(dev->spi, dev->spi_freq); /* Lock the device */
vs1053_setfrequency(dev, CONFIG_VS1053_MP3_DECODE_FREQ);
auddbg("Reset HDAT1=0x%0X HDAT0=0x%0X\n",
vs1053_readreg(dev, VS1053_SCI_HDAT1),
vs1053_readreg(dev, VS1053_SCI_HDAT0));
vs1053_spi_unlock(dev->spi);
/* Create a message queue for the worker thread */
snprintf(dev->mqname, sizeof(dev->mqname), "/tmp/%X", dev);
attr.mq_maxmsg = 16;
attr.mq_msgsize = sizeof(struct audio_msg_s);
attr.mq_curmsgs = 0;
attr.mq_flags = 0;
dev->mq = mq_open(dev->mqname, O_RDWR | O_CREAT, 0644, &attr);
if (dev->mq == NULL)
{
/* Error creating message queue! */
auddbg("Couldn't allocate message queue\n");
return -ENOMEM;
}
/* Pop the first enqueued buffer */
if ((ret = (sem_wait(&dev->apbq_sem)) == OK))
{
dev->pBuf = (FAR struct ap_buffer_s *) dq_remfirst(&dev->apbq);
apb_reference(dev->pBuf); /* Add our buffer reference */
sem_post(&dev->apbq_sem);
}
else
{
auddbg("Error getting APB Queue sem\n");
return ret;
}
/* Join any old worker thread we had created to prevent a memory leak */
if (dev->threadid != 0)
{
auddbg("Joining old thread\n");
pthread_join(dev->threadid, &value);
}
/* Start our thread for sending data to the device */
pthread_attr_init(&tattr);
sparam.sched_priority = sched_get_priority_max(SCHED_FIFO) - 3;
pthread_attr_setschedparam(&tattr, &sparam);
auddbg("Starting workerthread\n");
ret = pthread_create(&dev->threadid, &tattr, vs1053_workerthread,
(pthread_addr_t) dev);
if (ret != OK)
{
auddbg("Can't create worker thread, errno=%d\n", errno);
}
else
auddbg("Created worker thread\n");
return ret;
}
/****************************************************************************
* Name: vs1053_stop
*
* Description: Stop the configured operation (audio streaming, volume
* disabled, etc.).
*
****************************************************************************/
#ifndef CONFIG_AUDIO_EXCLUDE_STOP
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_stop(FAR struct audio_lowerhalf_s *lower, FAR void* session)
#else
static int vs1053_stop(FAR struct audio_lowerhalf_s *lower)
#endif
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
struct audio_msg_s term_msg;
FAR void* value;
/* Send a message to stop all audio streaming */
term_msg.msgId = AUDIO_MSG_STOP;
term_msg.u.data = 0;
mq_send(dev->mq, &term_msg, sizeof(term_msg), CONFIG_VS1053_MSG_PRIO);
/* Join the worker thread */
pthread_join(dev->threadid, &value);
dev->threadid = 0;
/* Reduce the decoder's operating frequency to save power */
vs1053_spi_lock(dev->spi, dev->spi_freq); /* Lock the device */
vs1053_setfrequency(dev, CONFIG_VS1053_XTALI);
vs1053_spi_unlock(dev->spi);
/* Wait for a bit */
up_mdelay(40);
return OK;
}
#endif
/****************************************************************************
* Name: vs1053_pause
*
* Description: Pauses the playback.
*
****************************************************************************/
#ifndef CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_pause(FAR struct audio_lowerhalf_s *lower, FAR void* session)
#else
static int vs1053_pause(FAR struct audio_lowerhalf_s *lower)
#endif
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
if (!dev->running)
return OK;
/* Disable interrupts to prevent us from suppling any more data */
dev->paused = TRUE;
dev->hw_lower->disable(dev->hw_lower); /* Disable the DREQ interrupt */
return OK;
}
#endif /* CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME */
/****************************************************************************
* Name: vs1053_resume
*
* Description: Resuems the playback.
*
****************************************************************************/
#ifndef CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_resume(FAR struct audio_lowerhalf_s *lower, FAR void* session)
#else
static int vs1053_resume(FAR struct audio_lowerhalf_s *lower)
#endif
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
if (!dev->running)
return OK;
/* Enable interrupts to allow suppling data */
dev->paused = FALSE;
vs1053_feeddata(dev);
dev->hw_lower->enable(dev->hw_lower); /* Enable the DREQ interrupt */
return OK;
}
#endif /* CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME */
/****************************************************************************
* Name: vs1053_enqueuebuffer
*
* Description: Enqueue an Audio Pipeline Buffer for playback/ processing.
*
****************************************************************************/
static int vs1053_enqueuebuffer(FAR struct audio_lowerhalf_s *lower,
FAR struct ap_buffer_s *apb )
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
struct audio_msg_s term_msg;
int ret;
audvdbg("Entry\n");
/* Lock access to the apbq */
if ((ret = sem_wait(&dev->apbq_sem)) == OK)
{
/* We can now safely add the buffer to the queue */
apb->curbyte = 0;
apb->flags = AUDIO_APB_OUTPUT_ENQUEUED;
dq_addlast(&apb->dq_entry, &dev->apbq);
sem_post(&dev->apbq_sem);
/* Send a message indicating a new buffer enqueued */
if (dev->mq != NULL)
{
term_msg.msgId = AUDIO_MSG_ENQUEUE;
term_msg.u.data = 0;
mq_send(dev->mq, &term_msg, sizeof(term_msg), CONFIG_VS1053_MSG_PRIO);
}
}
return ret;
}
/****************************************************************************
* Name: vs1053_cancelbuffer
*
* Description: Called when an enqueued buffer is being cancelled.
*
****************************************************************************/
static int vs1053_cancelbuffer(FAR struct audio_lowerhalf_s *lower,
FAR struct ap_buffer_s *apb )
{
return OK;
}
/****************************************************************************
* Name: vs1053_ioctl
*
* Description: Perform a device ioctl
*
****************************************************************************/
static int vs1053_ioctl(FAR struct audio_lowerhalf_s *lower, int cmd,
unsigned long arg)
{
#ifdef CONFIG_AUDIO_DRIVER_SPECIFIC_BUFFERS
FAR struct ap_buffer_info_s *pBufInfo;
#endif
/* Deal with ioctls passed from the upper-half driver */
switch (cmd)
{
/* Check for AUDIOIOC_HWRESET ioctl. This ioctl is passed straight
* through from the upper-half audio driver.
*/
case AUDIOIOC_HWRESET:
vs1053_hardreset((FAR struct vs1053_struct_s *) lower);
break;
/* Report our preferred buffer size and quantity */
#ifdef CONFIG_AUDIO_DRIVER_SPECIFIC_BUFFERS
case AUDIOIOC_GETBUFFERINFO:
pBufInfo = (FAR struct ap_buffer_info_s *) arg;
pBufInfo->buffer_size = CONFIG_VS1053_BUFFER_SIZE;
pBufInfo->nbuffers = CONFIG_VS1053_NUM_BUFFERS;
break;
#endif
default:
break;
}
return OK;
}
/****************************************************************************
* Name: vs1053_reserve
*
* Description: Reserves a session (the only one we have).
*
****************************************************************************/
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_reserve(FAR struct audio_lowerhalf_s *lower,
FAR void **psession)
#else
static int vs1053_reserve(FAR struct audio_lowerhalf_s *lower)
#endif
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
int ret = OK;
/* Borrow the APBQ semaphore for thread sync */
if (sem_wait(&dev->apbq_sem) != OK)
{
return -EBUSY;
}
if (dev->busy)
{
ret = -EBUSY;
}
else
{
/* Initialize the session context. We don't really use it. */
#ifdef CONFIG_AUDIO_MULTI_SESSION
*psession = NULL;
#endif
dev->busy = TRUE;
dev->running = FALSE;
dev->paused = FALSE;
}
sem_post(&dev->apbq_sem);
return ret;
}
/****************************************************************************
* Name: vs1053_release
*
* Description: Releases the session (the only one we have).
*
****************************************************************************/
#ifdef CONFIG_AUDIO_MULTI_SESSION
static int vs1053_release(FAR struct audio_lowerhalf_s *lower,
FAR void *psession)
#else
static int vs1053_release(FAR struct audio_lowerhalf_s *lower)
#endif
{
FAR struct vs1053_struct_s *dev = (struct vs1053_struct_s *) lower;
void *value;
/* Join any old worker thread we had created to prevent a memory leak */
if (dev->threadid != 0)
{
pthread_join(dev->threadid, &value);
dev->threadid = 0;
}
/* Borrow the APBQ semaphore for thread sync */
if (sem_wait(&dev->apbq_sem) != OK)
{
return -EBUSY;
}
/* Really we should free any queued buffers here */
dev->busy = 0;
sem_post(&dev->apbq_sem);
return OK;
}
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: vs1053_initialize
*
* Description:
* Initialize the VS1053 device
*
* Input Parameters:
* spidevice - This is a placeholder argument until the Audio interface
* has been flushed out a bit.
*
****************************************************************************/
struct audio_lowerhalf_s *vs1053_initialize(FAR struct spi_dev_s *spi,
FAR const struct vs1053_lower_s *lower,
unsigned int devno)
{
FAR struct vs1053_struct_s *dev;
uint16_t status;
uint8_t id;
uint8_t retry;
/* Sanity check */
DEBUGASSERT(spi != NULL);
DEBUGASSERT(lower != NULL);
DEBUGASSERT(lower->reset != NULL);
/* Allocate a VS1053 device structure */
dev = (struct vs1053_struct_s *)kmalloc(sizeof(struct vs1053_struct_s));
if (dev)
{
/* Initialize the VS1053 device structure */
dev->lower.ops = &g_audioops;
dev->lower.upper = NULL;
dev->lower.priv = NULL;
dev->hw_lower = lower;
dev->spi_freq = CONFIG_VS1053_XTALI / 7;
dev->spi = spi;
dev->mq = NULL;
dev->busy = FALSE;
dev->threadid = 0;
dev->running = 0;
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
dev->volume = 250; /* 25% volume as default */
#ifndef CONFIG_AUDIO_EXCLUDE_BALANCE
dev->balance = 500; /* Center balance */
#endif
#endif
#ifndef CONFIG_AUDIO_EXCLUDE_TONE
dev->bass = 0;
dev->treble = 0;
#endif
sem_init(&dev->apbq_sem, 0, 1);
dq_init(&dev->apbq);
/* Reset the VS1053 chip */
lower->reset(lower, false);
up_udelay(10);
lower->reset(lower, true);
up_udelay(VS1053_RST_USECS);
#if CONFIG_VS1053_XTALI == VS1053_DEFAULT_XTALI
/* If we have a standard crystal, then wait extra time
* for the DREQ to be active indicating the device is ready
*/
retry = 200;;
while (!lower->read_dreq(lower) && retry)
{
up_udelay(10);
retry--;
}
#endif
/* Do device detection to validate the chip is there.
* We have to hold the SPI lock during reads / writes.
*/
vs1053_spi_lock(spi, dev->spi_freq);
status = vs1053_readreg(dev, VS1053_SCI_STATUS);
vs1053_spi_unlock(spi);
/* Validate the device ID read from the chip */
id = (status & VS1053_SS_VER) >> VS1053_VER_SHIFT;
if (id != VS1053_VER_VS1053)
{
auddbg("Unexpected VER bits: 0x%0X\n", id);
kfree(dev);
return NULL;
}
else
{
auddbg("VS1053 Detected!\n");
}
/* Attach our ISR to this device */
dev->hw_lower->attach(dev->hw_lower, vs1053_dreq_isr);
/* Find a slot to save the device context for ISR lookup */
#if CONFIG_VS1053_DEVICE_COUNT == 1
g_isrdata[0] = dev; /* The simple case */
#else
/* The more complex case */
{
int x;
/* Initialize the ISR data if not alrady */
for (x = 0; x < CONFIG_VS1053_DEVICE_COUNT; x++)
{
/* Find an empty slot */
if (g_isrdata[x] == NULL)
{
g_isrdata[x] = dev;
break;
}
}
}
#endif
/* Do some initialization of the codec */
vs1053_shutdown(&dev->lower); /* Go to shutdown state */
}
return &dev->lower;
}
|