uart-drivers/uart.h at main · The-Chiselers/uart-drivers · GitHub

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
#ifndef UART_DRIVER_H
#define UART_DRIVER_H

#include <stdint.h>
#include <unistd.h>

// Base address and mapping size for your UART core
#define UART_BASE_ADDRESS 0x43C30000
#define UART_MAP_SIZE     0x1000    // 4KB page mapping

// Register offsets relative to the base address
#define TX_LOAD_OFFSET 0x0
#define TX_DATAIN_OFFSET 0x4
#define TX_BAUDRATE_OFFSET 0x8
#define TX_CLOCKFREQ_OFFSET 0xC
#define TX_UPDATEBAUD_OFFSET 0x10
#define TX_NUMOUTPUTBITSDB_OFFSET 0x14
#define TX_USEPARITYDB_OFFSET 0x18
#define TX_PARITYODDDB_OFFSET 0x1C
#define TX_ALMOSTEMPTYLEVEL_OFFSET 0x20
#define TX_ALMOSTFULLLEVEL_OFFSET 0x24
#define TX_FIFOFULL_OFFSET 0x28
#define TX_FIFOEMPTY_OFFSET 0x2C
#define TX_FIFOALMOSTEMPTY_OFFSET 0x30
#define TX_FIFOALMOSTFULL_OFFSET 0x34
#define RX_DATA_OFFSET 0x38
#define RX_DATAPEEK_OFFSET 0x3C
#define RX_DATAAVAILABLE_OFFSET 0x40
#define ERROR_OFFSET 0x44
#define CLEARERROR_OFFSET 0x48
#define RX_BAUDRATE_OFFSET 0x4C
#define RX_CLOCKFREQ_OFFSET 0x50
#define RX_UPDATEBAUD_OFFSET 0x54
#define RX_NUMOUTPUTBITSDB_OFFSET 0x58
#define RX_USEPARITYDB_OFFSET 0x5C
#define RX_PARITYODDDB_OFFSET 0x60
#define RX_ALMOSTEMPTYLEVEL_OFFSET 0x64
#define RX_ALMOSTFULLLEVEL_OFFSET 0x68
#define RX_FIFOFULL_OFFSET 0x6C
#define RX_FIFOEMPTY_OFFSET 0x70
#define RX_FIFOALMOSTEMPTY_OFFSET 0x74
#define RX_FIFOALMOSTFULL_OFFSET 0x78
#define RX_CLOCKSPERBIT_OFFSET 0x7C
#define TX_CLOCKSPERBIT_OFFSET 0x80
#define RX_LSBFIRST_OFFSET 0x84
#define TX_LSBFIRST_OFFSET 0x88
#define RX_FLUSH_OFFSET 0x8C
#define TX_FLUSH_OFFSET 0x90


// Macro to access a register: given a mapped base pointer and offset
#define REG(base, offset) (*(volatile uint32_t *)((char *)(base) + (offset)))

// Generic register set macro: read current value, clear bits (mask), then set new bits.
#define REGISTER_SET(base, offset, mask, shift, val) do { \
    REG(base, offset) = (REG(base, offset) & ~(mask)) | (((val) << (shift)) & (mask)); \
} while (0)

// Generic register set macro: read current value, clear bits (mask), then set new bits.
#define REGISTER_SET_VAL(base, offset, val) do { \
  REG(base, offset) =  (val); \
} while (0)

// Global variables for mmap and UART register base pointer.
static volatile void* uart_base = NULL;
static int uart_fd = -1;

void uart_initialize(void);
void uart_cleanup(void);

/* --------------------- Transmitter Functions --------------------- */

void uart_tx_set_baudrate(uint32_t clock_freq, uint32_t baud_rate);
void uart_tx_set_num_data_bits(uint8_t data_bits);
void uart_tx_set_use_parity(int use_parity);

void uart_tx_set_parity_odd(int parity_odd);
void uart_tx_set_lsb_first(int lsb_first);
int uart_tx_add_byte_to_queue(uint8_t data);
void uart_tx_send_queue(uint8_t data);

int uart_tx_send_byte(uint8_t data);
void uart_tx_set_almost_full_level(uint32_t almost_full_level);
int uart_tx_fifo_full(void);
int uart_tx_fifo_almost_full(void);
void uart_tx_set_almost_empty_level(uint32_t almost_empty_level);
int uart_tx_fifo_empty(void);
int uart_tx_fifo_almost_empty(void);
void uart_tx_flush(void);
void uart_tx_array(uint8_t* data, uint16_t length);

/* --------------------- Receiver Functions --------------------- */
void uart_rx_set_baudrate(uint32_t clock_freq, uint32_t baud_rate);
void uart_rx_set_num_data_bits(uint8_t data_bits);
void uart_rx_set_use_parity(int use_parity);

void uart_rx_set_parity_odd(int parity_odd);
void uart_rx_set_lsb_first(int lsb_first);
uint8_t uart_rx_read_byte(void);
uint8_t uart_rx_peek_byte(void);
int uart_rx_data_available(void);
void uart_rx_set_almost_full_level(uint32_t almost_full_level);
int uart_rx_fifo_full(void);
int uart_rx_fifo_almost_full(void);
void uart_rx_set_almost_empty_level(uint32_t almost_empty_level);
int uart_rx_fifo_empty(void);
int uart_rx_fifo_almost_empty(void);
void uart_rx_flush(void);
void uart_rx_read_array(uint8_t* response, uint16_t length);

/* --------------------- Common Functions --------------------- */
uint8_t uart_get_errors(void);
uint8_t uart_get_top_errors(void);
uint8_t uart_get_rx_errors(void);
uint8_t uart_get_tx_errors(void);
uint8_t uart_get_addr_decode_errors(void);

void uart_clear_errors(void);
uint32_t uart_get_rx_clocks_per_bit(void);
uint32_t uart_get_tx_clocks_per_bit(void);

#endif /* UART_DRIVER_H */