-
Notifications
You must be signed in to change notification settings - Fork 4
/
SerialBuffer.h
76 lines (60 loc) · 2.16 KB
/
SerialBuffer.h
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
// SPDX-License-Identifier: GPL-2.0-only
/**
* Digital Voice Modem - Hotspot Firmware
* GPLv2 Open Source. Use is subject to license terms.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* @package DVM / Hotspot Firmware
* @derivedfrom MMDVM_HS (https://github.com/g4klx/MMDVM_HS)
* @license GPLv2 License (https://opensource.org/licenses/GPL-2.0)
*
* Copyright (C) 2015,2016 Jonathan Naylor, G4KLX
* Serial FIFO Control Copyright (C) 2015 by James McLaughlin, KI6ZUM
* Copyright (C) 2022 Bryan Biedenkapp, N2PLL
*
*/
#if !defined(__SERIAL_RB_H__)
#define __SERIAL_RB_H__
#if defined(STM32F10X_MD)
#include "stm32f10x.h"
#elif defined(STM32F4XX)
#include "stm32f4xx.h"
#include <cstddef>
#endif
#include "Defines.h"
// ---------------------------------------------------------------------------
// Constants
// ---------------------------------------------------------------------------
const uint16_t SERIAL_RINGBUFFER_SIZE = 396U;
// ---------------------------------------------------------------------------
// Class Declaration
// Implements a circular buffer for serial data.
// ---------------------------------------------------------------------------
class DSP_FW_API SerialBuffer {
public:
/// <summary>Initializes a new instance of the SerialBuffer class.</summary>
SerialBuffer(uint16_t length = SERIAL_RINGBUFFER_SIZE);
/// <summary>Finalizes a instance of the SerialBuffer class.</summary>
~SerialBuffer();
/// <summary>Helper to get how much space the ring buffer has for samples.</summary>
uint16_t getSpace() const;
/// <summary></summary>
uint16_t getData() const;
/// <summary>Helper to reset data values to defaults.</summary>
void reset();
/// <summary>Helper to reset and reinitialize data values to defaults.</summary>
void reinitialize(uint16_t length);
/// <summary></summary>
bool put(uint8_t c);
/// <summary></summary>
uint8_t peek() const;
/// <summary></summary>
uint8_t get();
private:
uint16_t m_length;
volatile uint8_t* m_buffer;
volatile uint16_t m_head;
volatile uint16_t m_tail;
volatile bool m_full;
};
#endif // __SERIAL_RB_H__