xref: /openbmc/qemu/include/hw/char/ibex_uart.h (revision 8c6631e6)
1a7d2d98cSAlistair Francis /*
2a7d2d98cSAlistair Francis  * QEMU lowRISC Ibex UART device
3a7d2d98cSAlistair Francis  *
4a7d2d98cSAlistair Francis  * Copyright (c) 2020 Western Digital
5a7d2d98cSAlistair Francis  *
6a7d2d98cSAlistair Francis  * Permission is hereby granted, free of charge, to any person obtaining a copy
7a7d2d98cSAlistair Francis  * of this software and associated documentation files (the "Software"), to deal
8a7d2d98cSAlistair Francis  * in the Software without restriction, including without limitation the rights
9a7d2d98cSAlistair Francis  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10a7d2d98cSAlistair Francis  * copies of the Software, and to permit persons to whom the Software is
11a7d2d98cSAlistair Francis  * furnished to do so, subject to the following conditions:
12a7d2d98cSAlistair Francis  *
13a7d2d98cSAlistair Francis  * The above copyright notice and this permission notice shall be included in
14a7d2d98cSAlistair Francis  * all copies or substantial portions of the Software.
15a7d2d98cSAlistair Francis  *
16a7d2d98cSAlistair Francis  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17a7d2d98cSAlistair Francis  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18a7d2d98cSAlistair Francis  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19a7d2d98cSAlistair Francis  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20a7d2d98cSAlistair Francis  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21a7d2d98cSAlistair Francis  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22a7d2d98cSAlistair Francis  * THE SOFTWARE.
23a7d2d98cSAlistair Francis  */
24a7d2d98cSAlistair Francis 
25a7d2d98cSAlistair Francis #ifndef HW_IBEX_UART_H
26a7d2d98cSAlistair Francis #define HW_IBEX_UART_H
27a7d2d98cSAlistair Francis 
28a7d2d98cSAlistair Francis #include "hw/sysbus.h"
29a7d2d98cSAlistair Francis #include "chardev/char-fe.h"
30a7d2d98cSAlistair Francis #include "qemu/timer.h"
31db1015e9SEduardo Habkost #include "qom/object.h"
32a7d2d98cSAlistair Francis 
33a7d2d98cSAlistair Francis #define IBEX_UART_TX_FIFO_SIZE 16
34940aabb9SAlistair Francis #define IBEX_UART_CLOCK 50000000 /* 50MHz clock */
35a7d2d98cSAlistair Francis 
36a7d2d98cSAlistair Francis #define TYPE_IBEX_UART "ibex-uart"
378063396bSEduardo Habkost OBJECT_DECLARE_SIMPLE_TYPE(IbexUartState, IBEX_UART)
38a7d2d98cSAlistair Francis 
39db1015e9SEduardo Habkost struct IbexUartState {
40a7d2d98cSAlistair Francis     /* <private> */
41a7d2d98cSAlistair Francis     SysBusDevice parent_obj;
42a7d2d98cSAlistair Francis 
43a7d2d98cSAlistair Francis     /* <public> */
44a7d2d98cSAlistair Francis     MemoryRegion mmio;
45a7d2d98cSAlistair Francis 
46a7d2d98cSAlistair Francis     uint8_t tx_fifo[IBEX_UART_TX_FIFO_SIZE];
47a7d2d98cSAlistair Francis     uint32_t tx_level;
48a7d2d98cSAlistair Francis 
49*82a4ed8eSAlexander Wagner     uint32_t rx_level;
50*82a4ed8eSAlexander Wagner 
51a7d2d98cSAlistair Francis     QEMUTimer *fifo_trigger_handle;
52a7d2d98cSAlistair Francis     uint64_t char_tx_time;
53a7d2d98cSAlistair Francis 
54a7d2d98cSAlistair Francis     uint32_t uart_intr_state;
55a7d2d98cSAlistair Francis     uint32_t uart_intr_enable;
56a7d2d98cSAlistair Francis     uint32_t uart_ctrl;
57a7d2d98cSAlistair Francis     uint32_t uart_status;
58a7d2d98cSAlistair Francis     uint32_t uart_rdata;
59a7d2d98cSAlistair Francis     uint32_t uart_fifo_ctrl;
60a7d2d98cSAlistair Francis     uint32_t uart_fifo_status;
61a7d2d98cSAlistair Francis     uint32_t uart_ovrd;
62a7d2d98cSAlistair Francis     uint32_t uart_val;
63a7d2d98cSAlistair Francis     uint32_t uart_timeout_ctrl;
64a7d2d98cSAlistair Francis 
65940aabb9SAlistair Francis     Clock *f_clk;
66940aabb9SAlistair Francis 
67a7d2d98cSAlistair Francis     CharBackend chr;
68a7d2d98cSAlistair Francis     qemu_irq tx_watermark;
69a7d2d98cSAlistair Francis     qemu_irq rx_watermark;
70a7d2d98cSAlistair Francis     qemu_irq tx_empty;
71a7d2d98cSAlistair Francis     qemu_irq rx_overflow;
72db1015e9SEduardo Habkost };
73a7d2d98cSAlistair Francis #endif /* HW_IBEX_UART_H */
74