Diff: sw_fifo.hpp

Revision:

1:25a2b47ca291

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sw_fifo.hpp	Thu Aug 05 08:27:51 2021 +0000
@@ -0,0 +1,24 @@
+#define FIFO_BUFFER_SIZE 128 // software buffer size (in bytes)
+ 
+// UART data transmit function
+//  - checks if there's room in the transmit sw buffer
+//  - if there's room, it transfers data byte to sw buffer
+//  - automatically handles "uart_tx_buffer_full_flag"
+//  - sets the overflow flag upon software buffer overflow (doesn't overwrite existing data)
+//  - if this is the first data byte in the buffer, it enables the "hw buffer empty" interrupt
+void uart_send_byte(uint8_t byte);
+ 
+ 
+// UART data receive function
+//  - checks if data exists in the receive sw buffer
+//  - if data exists, it returns the oldest element contained in the buffer
+//  - automatically handles "uart_rx_buffer_full_flag"
+//  - if no data exists, it clears the uart_rx_flag
+uint8_t uart_get_byte(void);
+ 
+volatile extern uint8_t uart_rx_fifo_not_empty_flag; // this flag is automatically set and cleared by the software buffer
+volatile extern uint8_t uart_rx_fifo_full_flag;      // this flag is automatically set and cleared by the software buffer
+volatile extern uint8_t uart_rx_fifo_ovf_flag;       // this flag is not automatically cleared by the software buffer
+volatile extern uint8_t uart_tx_fifo_full_flag;      // this flag is automatically set and cleared by the software buffer
+volatile extern uint8_t uart_tx_fifo_ovf_flag;       // this flag is not automatically cleared by the software buffer
+volatile extern uint8_t uart_tx_fifo_not_empty_flag; // this flag is automatically set and cleared by the software buffer