Project: SPI_MSTransfer

I just added the loop around check for peekBytes and readBytes, so they fall through to /for loop/ if it's not aligned for memmove

Test code:

Code:
Circular_Buffer<uint16_t, 4> cb2;

  Serial.println("----------------------");
  cb2.write(0x8807);
  cb2.write(6);
  cb2.write(0x2113);
  cb2.write(0x2114);
  cb2.write(0x2115);
  cb2.write(0x2116);
  cb2.write(0x2117);
  cb2.write(0x2118);
  cb2.write(0x2119);
  Serial.print("Available: ");  Serial.println(cb2.available());

  Serial.println("readbytes:");
  uint16_t buf[6];
  Serial.print("Count: "); Serial.println(cb2.readBytes(buf, 6));
  for ( uint16_t i = 0; i < 6; i++ ) {
    Serial.print(buf[i], HEX); Serial.print(" ");
  } Serial.println();

  Serial.print("Print FIFO: ");  Serial.println(cb2.available());
  while ( cb2.available() > 0 ) {
    Serial.println(cb2.peek(), HEX);
    Serial.println(cb2.read(), HEX);
  }

Output:

Code:
----------------------
Available: 4
readbytes:
Count: 4
2116 2117 2118 2119 82C0 1FFF 
Print FIFO: 0

as you can see, the returned "count" was actually 4 when we requested 6, because the size of the queue wasnt A) large enough, and/or B) queue was too small
the last 2 dwords are garbage from printing the local array where only the first 4 values were updated! :)


Heres the updated v1.1 with the protection added to readBytes and peekBytes with fallback /for loop/ support when memmove wont wrap

View attachment circular_buffer v1.1.zip

the peek() overload really helped the peekBytes method for loop fallback:

Code:
template<typename T, uint16_t _size>
T Circular_Buffer<T,_size>::peekBytes(T *buffer, uint16_t length) {
  uint16_t _count;
  ( available() < length ) ? _count = available() : _count = length;
  if ( _count < ( _size - head ) ) {
    memmove(buffer,_cbuf,_count*sizeof(T));
  }
  [COLOR="#FF0000"][B]else for ( uint16_t i = 0; i < _count; i++ ) buffer[i] = peek(i);[/B][/COLOR]
  return _count;
}
 
v1.2 is here, added flush() method, which resets the head and tail so queue is set as empty
also removed some debug code

Code:
[B][ATTACH]13306._xfImport[/ATTACH][/B]
 
Just gave your example a try on a T3.1 from p699 a try. I opened the monitor and it was finished before I even released the mouse button (or so it seemed). Wow :)


Mike
PS My 8266 problem boiled down to a bad solder joint between the 8266 TX pin and the pad on the board. Have to pull out the soldering iron again tomorrow :)
 
Hi mike!

I added something else to the circular fifo!!! :)

#1, available() did not work "sometimes", now I use a counter for the queues which works excellent
#2, BONUS!!:
Added push_back and push_front methods! What!? Thats right, you can inject data to the FRONT of the QUEUE, NOT JUST THE REAR! :)

demo code:

Code:
  Serial.println("----------------------");
  cb.write(0x1111);
  cb.write(0x1112);
  cb.write(0x1113);
  cb.write(0x1114);
  cb.write(0x1115);
  cb.push_front(0x85);
  cb.push_back(0x33);
  cb.push_front(0x66);
  Serial.print("Available: ");  Serial.println(cb.available());
  while ( cb.available() > 0 ) {
    Serial.println(cb.pop(), HEX);
  }

Output:

Code:
Available: 8
66
85
1111
1112
1113
1114
1115
33
 
new methods are:

Code:
        void push_back(T value) { return write(value); }
        void push_front(T value);
        T pop_front() { return read(); }
        T pop_back();

they allow you to push/pop a single type from either end of the circular queue! :)

Code:
[QUOTE][ATTACH]13312._xfImport[/ATTACH][/QUOTE]

Essentially, now this circular buffer supports FIFO & LIFO & mixed mode, amongst multiple buffer support!

What does this mean? We could queue up data as normal, and if a priority is required it can be pushed ahead of the line by push_front'ing an array in reverse into the queue
I should probably add an automated method that does it via for loops to inject arrays to ahead of the queue like so:

Code:
void push_front(const T *buffer, uint16_t length);

this would take your given array and length, and use a for loop to inject the array in the front of the queue reading from last Type of array to the first, so it's in order when it's dequeued!
 
alright, how's this?

Code:
  Serial.println("----------------------");
  cb.write(0x1111);
  cb.write(0x1112);
  cb.write(0x1113);
  cb.write(0x1114);
  cb.write(0x1115);
  cb.push_front(0x85);
  cb.push_back(0x33);
  cb.push_front(0x66);
[B][COLOR="#FF0000"]  uint16_t myBuf[] = { 1, 2, 3, 4, 5 };
  cb.push_front(myBuf, 5);[/COLOR][/B]
  Serial.print("Available: ");  Serial.println(cb.available());
  while ( cb.available() > 0 ) {
    Serial.println(cb.pop_front(), HEX);
  }

Output:

Code:
----------------------
Available: 13
1
2
3
4
5
66
85
1111
1112
1113
1114
1115
33

am i the only one pushing arrays into circular queues or what? lol
 
heres another example of push_back and push_front working together with single writes

Note: write is same as push_back, they can be used interchangably
------ read is same as pop_front, can be used interchangably
------ write(buf,len) is same as push_back(buf,len),, can be used interchangably
------ read/readBytes(buf,len) is same as pop_front(buffer,length) , can be used interchangably

Code:
  cb4.write(0x2113);
  cb4.write(0x2114);
  uint16_t buff[4] = { 'T', 'o', 'n', 'y' };
[B][COLOR="#FF0000"]  cb4.push_front(buff, 4);
  cb4.push_back(buff, 4);[/COLOR][/B]
  cb4.write(0x2115);
  cb4.write(0x2116);

  Serial.print("cb4 Available: ");  Serial.println(cb4.available());

  Serial.println("Printout:");
  while ( cb4.available() > 0 ) {
    Serial.println(cb4.read(), HEX);
  }

output:

Code:
cb4 Available: 12
Printout:
[B]54
6F
6E
79[/B]
2113
2114
[B]54
6F
6E
79[/B]
2115
2116


v1.4 is here with all those goodie additions! Enjoy :)
Code:
[ATTACH]13316._xfImport[/ATTACH]

if anyone finds "bugs" let me know, once its solid I will start working on the MST library, I just dont want some bugs throwing me off if MST starts failing at some point while implementing, might make me think its a different problem :p

worst possible thing a bug can introduce is a sync issue, in any case, my serial parser will advance to the next MST frame, which will discard unknown bytes from 1st frame, so rather than take a hit like that, I'd like to fix any bugs that are found to make things more stable :)

Also, I think I will add a size() overload for available(), just because c++ queues use size() for the size of the queue, and since i implemented push&pop functionality, lets follow the norm :)

Added size() method to compliment available()
Code:
[ATTACH]13317._xfImport[/ATTACH]
 
Last edited:
Here's another example that looks good, writing a 3000 increment to a 2048 buffer

Code:
Circular_Buffer<uint16_t, 2048> cb;

  for ( uint16_t i = 0; i < 3000; i++ ) cb.write(i);
  Serial.print("Size: "); Serial.println(cb.size());
  uint16_t size = cb.size();
  for ( uint16_t i = 0; i < size; i++ ) Serial.println(cb.read());

output:

Code:
----------------------
Size: 2048
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
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999

as you can see, the final queued item is 2999 (3000th dWord)
the first of the queue is 952

so with the rollover we get 952 -> 2999 which is good since 3000-2048 == 952 :)
and...
2999 - 952 == 2047 (the write position of the next input is not counted)
 
now, lets take same code and try a 3000 increment followed by a 5 dword array pushed to front of the FIFO

BOLD == added

Code:
  for ( uint16_t i = 0; i < 3000; i++ ) cb.write(i);
 [B][COLOR="#FF0000"] uint16_t myBuf2[] = { 1, 2, 3, 4, 5 };
  cb.push_front(myBuf2, 5);[/COLOR][/B]
  Serial.print("Size: "); Serial.println(cb.size());
  uint16_t size = cb.size();
  for ( uint16_t i = 0; i < size; i++ ) Serial.println(cb.read());


and the output:

Code:
----------------------
Size: 2048
1
2
3
4
5
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
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994

as you can see, they are all intact and shifted properly, since the queue was full, the tail was pushed back to squeeze the array into front of line :)
 
OK, timing details!

Code:
  uint32_t time = micros();
  for ( uint16_t i = 0; i < 30; i++ ) cb.write(i);
  uint16_t myBuf2[] = { 1, 2, 3, 4, 5 };
  cb.push_front(myBuf2, 5);
  Serial.print(micros() - time);
  Serial.print("Size: "); Serial.println(cb.size());
  uint16_t size = cb.size();
  for ( uint16_t i = 0; i < size; i++ ) Serial.println(cb.read());

Result: 500 micros to do 3000 entries plus an array of 5 dwords

Next test:

Code:
  uint32_t time = micros();
  for ( uint16_t i = 0; i < 30; i++ ) cb.write(i);
//  uint16_t myBuf2[] = { 1, 2, 3, 4, 5 };
//  cb.push_front(myBuf2, 5);
  Serial.print(micros() - time);
  Serial.print("Size: "); Serial.println(cb.size());
  uint16_t size = cb.size();
  for ( uint16_t i = 0; i < size; i++ ) Serial.println(cb.read());
  return;

Code:
Result: 5 micros for 30 entries!
          3 micros for 20 entries!
          10 micros for 60 entries!
          15 micros for 100 entries!
 
and if you think memmove is fast, lets verify it via buffer writing :)

Code:
  uint16_t testBuf[100];
  for ( uint16_t i = 0; i < 100; i++ ) testBuf[i] = i;
  uint32_t time = micros();

  [B][COLOR="#FF0000"]cb.write(testBuf, 100);[/COLOR][/B]
  //  uint16_t myBuf2[] = { 1, 2, 3, 4, 5 };
  //  cb.push_front(myBuf2, 5);
  Serial.print(micros() - time);
  Serial.print("Size: "); Serial.println(cb.size());
  uint16_t size = cb.size();
  for ( uint16_t i = 0; i < size; i++ ) Serial.println(cb.read());

Output:

Code:
----------------------
3Size: 100  [COLOR="#FF0000"][B]<--------------- 3 micros to insert a 100 byte array via memmove!!!!!!!! Thats 5 times faster than pushing 1 at a time (3uS vs 15uS) [/B][/COLOR]
0
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
 
Last edited:
Looking good.

To be clear each instance cb :: Circular_Buffer<uint16_t, 2048> cb;

Is a single group of bytes ( stored as 2048 uint16_t's )? Tracked with a Single Head and Tail in a pre-allocated buffer?

For SPI_MST It would represent ONE SPI transfer sequence at a time as a buffer to hold a send or receive? So one 'cbS' would be created to queue a send to Master from Slave and a second 'cbM' would be used to pull in a SPI ?

And for Master event storage it would take an array/group of them to hold multiple transfer messages?
 
Ok I opened a github repo now (my first attempt) :D

Tim I copied your files over (examples and readme) and added the circular buffer in the same SPI_MSTransfer since the library will be using it in future, i also put the v0.1.5 MST on there for now till the new version will come along
 
Essentially, now this circular buffer supports FIFO & LIFO & mixed mode, amongst multiple buffer support!
Not essentially, definitely!!!!
Just finished reading through your posts - egads. Going to take me a while to get my head around this. Don't think I have ever seen anything like this before. Can't wait to see what this does to the SPI library.
 
yes, 2048 uint16_t's, buffer is preallocated, there is no resizing, malloc, or new at all

Yes, we can create multiple buffers

example
Circular_Buffer<uint16_t, 2048> mts;
Circular_Buffer<uint16_t, 2048> stm;

mts == master to slave transfers
stm == slave to master transfers

the ISR would control the tail and the loop would control the head of mts queue
for stm, loop controls tail, isr controls head

we could do all buffer writes from the ISR / LOOP, only the end of array will do a single fall-back for loop, all other times memmove has full aligned array transfers
so the ISR buffer can be instantly dropped into the queue and quit immediately ready for next transfer!

with read/readBytes/pop_front(buffer,length) and complimented peek(overload), we could do same for the callback, pulling the entire "array" out of queue as a single chunk! (with a for loop only happening around the edge)
 
...
Circular_Buffer<uint16_t, 2048> mts;
Circular_Buffer<uint16_t, 2048> stm;

mts == master to slave transfers
stm == slave to master transfers

the ISR would control the tail and the loop would control the head of mts queue
for stm, loop controls tail, isr controls head

Okay - better picture for me of its usage.

So it is a stream of bytes : Incoming Master Messages are stored there in 'mts' - when slave sees it not empty it has incoming data, just needs to know how to read the part that represents 'an event'

Problem would be in 'stm'? : Slave starts pushing data - say 100 bytes. Some halfway through the isr() fires and it is an incomplete transfer - but 'stm' is not empty so the isr() would want to push it out?
 
adding checks wont be hard

thats where peek comes in, if the peek(val) (lets say position 1) which should be length, is not same or higher than the availability, the ISR wont start transfer to the master and instead will send a "no queue" signal instead

Most important is we align the header of the callback systems, capture its next value via peek, and pull the entire array if it's considered complete within size()/available() limits

So if the ISR wants to interrupt partially through a loop writing buffer, it'll resume after the ISR exits after telling the master "no new entries available"

if your starting to write the second array from loop to the buffer, and the ISR fires partially through, the first array will be passed through and ISR exits, loop continues finishing the second write, and the head will be pointed to the 2nd write(which is actually the first now) :)
 
Okay - That note about peek() was back there a ways.

Seems like that will solve the SPI_MST issues of dynamic allocation and overhead of 'library' code - and also the interrupt data integrity problems.

Indeed this is a handy way to set data aside quickly for buffer handling later. Could be debug data from an ISR, or TeensyThreaded sketch output, or to do 512 block writes to SD card. Sketch just puts bytes in and then the part that cares pumps them out as time or space dictates/allows? Would that call for a stream class interface to allow cb.print( "Hello World!"); ?
 
like, im just writing this out by hand:

if ( cb.peek(1) > cb.size() ) return; // the array is not completely written yet

while ( cb.size() && cb.peek() != 0x9244 ) cb.read(); // if theres entries, lets get to the header position, make sure it's there
buf[cb.peek(1)];
cb.read(buf,sizeof(buf)/2);

// process buf......

the FIFO/LIFO mixture cant be used with the ISR for obvious reasons, however, in normal non-ISR code, you can use FIFO & LIFO together on the same buffer for prioritizing tasks in the circular buffer

I just added the cb demo up on github as well, to demonstrate most features including FIFO and LIFO, and how they can be used separately, or together

you suggest I add the stream class? or just the print methods should be enough probably, if your only case was to "print"/"println" to the circular buffer, then thats possible without stream

in the MST cpp you can see the methods for print & println actually use the "write" method, maybe that gives you a better idea of what im saying
 
Last edited:
like, im just writing this out by hand:

if ( cb.peek(1) > cb.size() ) return; // the array is not completely written yet

while ( cb.size() && cb.peek() != 0x9244 ) cb.read(); // if theres entries, lets get to the header position, make sure it's there
buf[cb.peek(1)];
cb.read(buf,sizeof(buf)/2);

// process buf......

I can see that being close. If cb.peek(1) is the size of the Transfer that would need to be recorded. Like this? Where MySize is captured and used as needed

if ( cb.peek(1) > cb.size() ) return; // the array is not completely written yet
uint16_t MySize = cb.read();
while ( cb.size() && cb.peek() != 0x9244 ) cb.read(); // if theres entries, lets get to the header position, make sure it's there
// ...
 
cb.read would pull position 0 (header) not the length (peek(1));
same with peek() or peek(0), which is first position, which should be header if its syncd properly
similarly, we could read further down the line without pulling

peek(3) reads the 4th position
peekBytes can read an entire block without modifying the head, so you could even look into the buffer to differentiate different callback usages or anything else you want before actually read/readBytes/pop_back'ing
 
cb.read would pull position 0 (header) not the length (peek(1));

Correct(ed) - so it would have to plan to fail if the header not found as first peek(). Data would be a mess if the peek(1) is size but peek(0) is not header and the while(not happy) cb.read() just exhausted the buffer.

Will take some attention. The "if ( cb.peek(1) > cb.size() )" test would have to be redone as the buffer may be too short now once header found?
 
its just something i typed out without testing for a general idea
yes theres obvious flaws when that happens :)
the header would need to be scanned first, then the length to create its buffer, and the pull must be of length only if it A) doesnt exceed capacity, and B), is actually within capacity :)
 
Back
Top