serial: uart_liteuart: Add and use register names

Adds addresses and names for individual CSR registers to device tree.
This way liteuart driver no longer depends on CSR data width being 8
bits.
Also when register names or their number changes, then overlay generated
by LiteX will be incompatible with one defined here.
This should make finding breaking changes easier.

I also appended `_ADDR` suffix to defines, to distinguish them from
normal values like `UART_EX_TX`.

Signed-off-by: Michal Sieron <msieron@internships.antmicro.com>
This commit is contained in:
Michal Sieron 2022-04-11 15:12:37 +02:00 committed by Carles Cufí
commit 081e201219
2 changed files with 53 additions and 36 deletions

View file

@ -14,16 +14,18 @@
#include <drivers/uart.h>
#include <zephyr/types.h>
#define UART_EV_TX (1 << 0)
#define UART_EV_RX (1 << 1)
#define UART_BASE_ADDR DT_INST_REG_ADDR(0)
#define UART_RXTX ((UART_BASE_ADDR) + 0x00)
#define UART_TXFULL ((UART_BASE_ADDR) + 0x04)
#define UART_RXEMPTY ((UART_BASE_ADDR) + 0x08)
#define UART_EV_STATUS ((UART_BASE_ADDR) + 0x0c)
#define UART_EV_PENDING ((UART_BASE_ADDR) + 0x10)
#define UART_EV_ENABLE ((UART_BASE_ADDR) + 0x14)
#define UART_IRQ DT_INST_IRQN(0)
#define UART_RXTX_ADDR DT_INST_REG_ADDR_BY_NAME(0, rxtx)
#define UART_TXFULL_ADDR DT_INST_REG_ADDR_BY_NAME(0, txfull)
#define UART_RXEMPTY_ADDR DT_INST_REG_ADDR_BY_NAME(0, rxempty)
#define UART_EV_STATUS_ADDR DT_INST_REG_ADDR_BY_NAME(0, ev_status)
#define UART_EV_PENDING_ADDR DT_INST_REG_ADDR_BY_NAME(0, ev_pending)
#define UART_EV_ENABLE_ADDR DT_INST_REG_ADDR_BY_NAME(0, ev_enable)
#define UART_TXEMPTY_ADDR DT_INST_REG_ADDR_BY_NAME(0, txempty)
#define UART_RXFULL_ADDR DT_INST_REG_ADDR_BY_NAME(0, rxfull)
#define UART_EV_TX (1 << 0)
#define UART_EV_RX (1 << 1)
#define UART_IRQ DT_INST_IRQN(0)
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
typedef void (*irq_cfg_func_t)(void);
@ -56,10 +58,10 @@ struct uart_liteuart_data {
static void uart_liteuart_poll_out(const struct device *dev, unsigned char c)
{
/* wait for space */
while (litex_read8(UART_TXFULL)) {
while (litex_read8(UART_TXFULL_ADDR)) {
}
litex_write8(c, UART_RXTX);
litex_write8(c, UART_RXTX_ADDR);
}
/**
@ -72,13 +74,13 @@ static void uart_liteuart_poll_out(const struct device *dev, unsigned char c)
*/
static int uart_liteuart_poll_in(const struct device *dev, unsigned char *c)
{
if (!litex_read8(UART_RXEMPTY)) {
*c = litex_read8(UART_RXTX);
if (!litex_read8(UART_RXEMPTY_ADDR)) {
*c = litex_read8(UART_RXTX_ADDR);
/* refresh UART_RXEMPTY by writing UART_EV_RX
* to UART_EV_PENDING
*/
litex_write8(UART_EV_RX, UART_EV_PENDING);
litex_write8(UART_EV_RX, UART_EV_PENDING_ADDR);
return 0;
} else {
return -1;
@ -93,9 +95,9 @@ static int uart_liteuart_poll_in(const struct device *dev, unsigned char *c)
*/
static void uart_liteuart_irq_tx_enable(const struct device *dev)
{
uint8_t enable = litex_read8(UART_EV_ENABLE);
uint8_t enable = litex_read8(UART_EV_ENABLE_ADDR);
litex_write8(enable | UART_EV_TX, UART_EV_ENABLE);
litex_write8(enable | UART_EV_TX, UART_EV_ENABLE_ADDR);
}
/**
@ -105,9 +107,9 @@ static void uart_liteuart_irq_tx_enable(const struct device *dev)
*/
static void uart_liteuart_irq_tx_disable(const struct device *dev)
{
uint8_t enable = litex_read8(UART_EV_ENABLE);
uint8_t enable = litex_read8(UART_EV_ENABLE_ADDR);
litex_write8(enable & ~(UART_EV_TX), UART_EV_ENABLE);
litex_write8(enable & ~(UART_EV_TX), UART_EV_ENABLE_ADDR);
}
/**
@ -117,9 +119,9 @@ static void uart_liteuart_irq_tx_disable(const struct device *dev)
*/
static void uart_liteuart_irq_rx_enable(const struct device *dev)
{
uint8_t enable = litex_read8(UART_EV_ENABLE);
uint8_t enable = litex_read8(UART_EV_ENABLE_ADDR);
litex_write8(enable | UART_EV_RX, UART_EV_ENABLE);
litex_write8(enable | UART_EV_RX, UART_EV_ENABLE_ADDR);
}
/**
@ -129,9 +131,9 @@ static void uart_liteuart_irq_rx_enable(const struct device *dev)
*/
static void uart_liteuart_irq_rx_disable(const struct device *dev)
{
uint8_t enable = litex_read8(UART_EV_ENABLE);
uint8_t enable = litex_read8(UART_EV_ENABLE_ADDR);
litex_write8(enable & ~(UART_EV_RX), UART_EV_ENABLE);
litex_write8(enable & ~(UART_EV_RX), UART_EV_ENABLE_ADDR);
}
/**
@ -143,7 +145,7 @@ static void uart_liteuart_irq_rx_disable(const struct device *dev)
*/
static int uart_liteuart_irq_tx_ready(const struct device *dev)
{
uint8_t val = litex_read8(UART_TXFULL);
uint8_t val = litex_read8(UART_TXFULL_ADDR);
return !val;
}
@ -159,7 +161,7 @@ static int uart_liteuart_irq_rx_ready(const struct device *dev)
{
uint8_t pending;
pending = litex_read8(UART_EV_PENDING);
pending = litex_read8(UART_EV_PENDING_ADDR);
if (pending & UART_EV_RX) {
return 1;
@ -182,8 +184,8 @@ static int uart_liteuart_fifo_fill(const struct device *dev,
{
int i;
for (i = 0; i < size && !litex_read8(UART_TXFULL); i++) {
litex_write8(tx_data[i], UART_RXTX);
for (i = 0; i < size && !litex_read8(UART_TXFULL_ADDR); i++) {
litex_write8(tx_data[i], UART_RXTX_ADDR);
}
return i;
@ -203,13 +205,13 @@ static int uart_liteuart_fifo_read(const struct device *dev,
{
int i;
for (i = 0; i < size && !litex_read8(UART_RXEMPTY); i++) {
rx_data[i] = litex_read8(UART_RXTX);
for (i = 0; i < size && !litex_read8(UART_RXEMPTY_ADDR); i++) {
rx_data[i] = litex_read8(UART_RXTX_ADDR);
/* refresh UART_RXEMPTY by writing UART_EV_RX
* to UART_EV_PENDING
*/
litex_write8(UART_EV_RX, UART_EV_PENDING);
litex_write8(UART_EV_RX, UART_EV_PENDING_ADDR);
}
return i;
@ -231,7 +233,7 @@ static int uart_liteuart_irq_is_pending(const struct device *dev)
{
uint8_t pending;
pending = litex_read8(UART_EV_PENDING);
pending = litex_read8(UART_EV_PENDING_ADDR);
if (pending & (UART_EV_TX | UART_EV_RX)) {
return 1;
@ -272,7 +274,7 @@ static void liteuart_uart_irq_handler(const struct device *dev)
}
/* clear events */
litex_write8(UART_EV_TX | UART_EV_RX, UART_EV_PENDING);
litex_write8(UART_EV_TX | UART_EV_RX, UART_EV_PENDING_ADDR);
irq_unlock(key);
}
@ -303,7 +305,7 @@ static struct uart_liteuart_data uart_liteuart_data_0;
static int uart_liteuart_init(const struct device *dev);
static const struct uart_liteuart_device_config uart_liteuart_dev_cfg_0 = {
.port = UART_BASE_ADDR,
.port = UART_RXTX_ADDR,
.baud_rate = DT_INST_PROP(0, current_speed)
};
@ -316,7 +318,7 @@ DEVICE_DT_INST_DEFINE(0,
static int uart_liteuart_init(const struct device *dev)
{
litex_write8(UART_EV_TX | UART_EV_RX, UART_EV_PENDING);
litex_write8(UART_EV_TX | UART_EV_RX, UART_EV_PENDING_ADDR);
#ifdef CONFIG_UART_INTERRUPT_DRIVEN
IRQ_CONNECT(UART_IRQ, DT_INST_IRQ(0, priority),