/** @file uart_circular.h
 *
 *  @brief Single-producer, single-consumer UART circular buffer
 *
 */

#ifndef _UART_CIRCULAR_H_
#define _UART_CIRCULAR_H_


#include <stdbool.h>
#include <stdint.h>


/* PUBLIC TYPEDEFS */

typedef bool (*uart_circular_fifo_read_fn)(void *context, uint8_t *byte);
typedef bool (*uart_circular_fifo_has_data_fn)(void *context);
typedef void (*uart_circular_data_fn)(void *context, const uint8_t *data, uint32_t length);
typedef uint32_t (*uart_circular_get_interrupt_fn)(void *context);
typedef void (*uart_circular_event_fn)(void *context);
typedef void (*uart_circular_rx_count_fn)(void *context, uint32_t count);

typedef struct
{
    uint8_t *storage;
    uint32_t capacity;
    volatile uint32_t producer_index;
    volatile uint32_t consumer_index;
} uart_circular_buffer;

/* Interrupt masks use the target UART's interrupt identity representation. */
typedef struct
{
    uart_circular_buffer *buffer;
    uint32_t rx_interrupt_mask;
    uint32_t rx_line_error_mask;
    uint32_t rx_timeout_mask;
    uint32_t tx_interrupt_mask;
    uart_circular_get_interrupt_fn get_interrupt_status;
    uart_circular_fifo_read_fn read_byte;
    uart_circular_fifo_has_data_fn fifo_has_data;
    uart_circular_event_fn on_rx_line_error;
    uart_circular_event_fn on_rx_timeout_empty;
    uart_circular_rx_count_fn on_rx_bytes_drained;
    uart_circular_event_fn on_rx_buffer_full;
    uart_circular_event_fn on_tx_threshold;
    void *context;
} uart_circular_isr_params;

/* PUBLIC VARIABLES */

/* PUBLIC FUNCTION PROTOTYPES */

bool uart_circular_init(uart_circular_buffer *buffer, uint8_t *storage, uint32_t capacity);
uint32_t uart_circular_drain_fifo(uart_circular_buffer *buffer,
                                  uart_circular_fifo_read_fn read_byte, void *context);
/* Register this as the UART ISR callback and pass uart_circular_isr_params as its argument. */
void uart_circular_isr(void *args);
uint32_t uart_circular_process(uart_circular_buffer *buffer, uint32_t max_length,
                               uart_circular_data_fn process_data, void *context);
uint32_t uart_circular_get_producer(const uart_circular_buffer *buffer);
uint32_t uart_circular_get_consumer(const uart_circular_buffer *buffer);
uint32_t uart_circular_get_occupancy(const uart_circular_buffer *buffer);
bool uart_circular_is_full(const uart_circular_buffer *buffer);

/* PUBLIC INLINEABLE FUNCTION PROTOTYPES */

#endif /* _UART_CIRCULAR_H_ */
