 |
Software APIs
|
|
Software APIs
|
Device Tables (DT) for IP uart and top earlgrey. More...
#include "hw/top/dt/dt_api.h"#include <stdint.h>Go to the source code of this file.
Macros | |
| #define | OPENTITAN_UART_HAS_PARITY 1 |
| List of supported hardware features. | |
| #define | OPENTITAN_UART_HAS_LINE_LOOPBACK 1 |
| #define | OPENTITAN_UART_HAS_SYSTEM_LOOPBACK 1 |
| #define | OPENTITAN_UART_HAS_BAUD_RATE_CONTROL 1 |
| #define | OPENTITAN_UART_HAS_LINE_BREAK 1 |
| #define | OPENTITAN_UART_HAS_FIFO_INTERRUPTS 1 |
Typedefs | |
| typedef enum dt_uart | dt_uart_t |
| List of instances. | |
| typedef enum dt_uart_reg_block | dt_uart_reg_block_t |
| List of register blocks. | |
| typedef enum dt_uart_memory | dt_uart_memory_t |
| List of memories. | |
| typedef enum dt_uart_irq | dt_uart_irq_t |
| List of IRQs. | |
| typedef enum dt_uart_alert | dt_uart_alert_t |
| List of Alerts. | |
| typedef enum dt_uart_clock | dt_uart_clock_t |
| List of clock ports. | |
| typedef enum dt_uart_reset | dt_uart_reset_t |
| List of reset ports. | |
| typedef enum dt_uart_periph_io | dt_uart_periph_io_t |
| List of peripheral I/O. | |
Enumerations | |
| enum | dt_uart { kDtUart0 = 0 , kDtUart1 = 1 , kDtUart2 = 2 , kDtUart3 = 3 , kDtUartFirst = 0 , kDtUartCount = 4 } |
| List of instances. More... | |
| enum | dt_uart_reg_block { kDtUartRegBlockCore = 0 , kDtUartRegBlockCount = 1 } |
| List of register blocks. More... | |
| enum | dt_uart_memory { kDtUartMemoryCount = 0 } |
| List of memories. More... | |
| enum | dt_uart_irq { kDtUartIrqTxWatermark = 0 , kDtUartIrqRxWatermark = 1 , kDtUartIrqTxDone = 2 , kDtUartIrqRxOverflow = 3 , kDtUartIrqRxFrameErr = 4 , kDtUartIrqRxBreakErr = 5 , kDtUartIrqRxTimeout = 6 , kDtUartIrqRxParityErr = 7 , kDtUartIrqTxEmpty = 8 , kDtUartIrqCount = 9 } |
| List of IRQs. More... | |
| enum | dt_uart_alert { kDtUartAlertFatalFault = 0 , kDtUartAlertCount = 1 } |
| List of Alerts. More... | |
| enum | dt_uart_clock { kDtUartClockClk = 0 , kDtUartClockCount = 1 } |
| List of clock ports. More... | |
| enum | dt_uart_reset { kDtUartResetRst = 0 , kDtUartResetCount = 1 } |
| List of reset ports. More... | |
| enum | dt_uart_periph_io { kDtUartPeriphIoRx = 0 , kDtUartPeriphIoTx = 1 , kDtUartPeriphIoCount = 2 } |
| List of peripheral I/O. More... | |
Functions | |
| dt_uart_t | dt_uart_from_instance_id (dt_instance_id_t inst_id) |
| Get the uart instance from an instance ID. | |
| dt_instance_id_t | dt_uart_instance_id (dt_uart_t dt) |
| Get the instance ID of an instance. | |
| uint32_t | dt_uart_reg_block (dt_uart_t dt, dt_uart_reg_block_t reg_block) |
| Get the register base address of an instance. | |
| uint32_t | dt_uart_memory_base (dt_uart_t dt, dt_uart_memory_t mem) |
| Get the base address of a memory. | |
| uint32_t | dt_uart_memory_size (dt_uart_t dt, dt_uart_memory_t mem) |
| Get the size of a memory. | |
| dt_plic_irq_id_t | dt_uart_irq_to_plic_id (dt_uart_t dt, dt_uart_irq_t irq) |
| Get the PLIC ID of a uart IRQ for a given instance. | |
| dt_uart_irq_t | dt_uart_irq_from_plic_id (dt_uart_t dt, dt_plic_irq_id_t irq) |
| Convert a global IRQ ID to a local uart IRQ type. | |
| dt_alert_id_t | dt_uart_alert_to_alert_id (dt_uart_t dt, dt_uart_alert_t alert) |
| Get the alert ID of a uart alert for a given instance. | |
| dt_uart_alert_t | dt_uart_alert_from_alert_id (dt_uart_t dt, dt_alert_id_t alert) |
| Convert a global alert ID to a local uart alert type. | |
| dt_periph_io_t | dt_uart_periph_io (dt_uart_t dt, dt_uart_periph_io_t sig) |
| Get the peripheral I/O description of an instance. | |
| dt_clock_t | dt_uart_clock (dt_uart_t dt, dt_uart_clock_t clk) |
| Get the clock signal connected to a clock port of an instance. | |
| dt_reset_t | dt_uart_reset (dt_uart_t dt, dt_uart_reset_t rst) |
| Get the reset signal connected to a reset port of an instance. | |
Device Tables (DT) for IP uart and top earlgrey.
This file contains the type definitions and global functions of the uart.
Definition in file dt_uart.h.
| #define OPENTITAN_UART_HAS_PARITY 1 |
| typedef enum dt_uart_alert dt_uart_alert_t |
List of Alerts.
Alerts are guaranteed to be numbered consecutively from 0.
| typedef enum dt_uart_clock dt_uart_clock_t |
List of clock ports.
Clock ports are guaranteed to be numbered consecutively from 0.
| typedef enum dt_uart_irq dt_uart_irq_t |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| typedef enum dt_uart_memory dt_uart_memory_t |
List of memories.
Memories are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_uart_periph_io dt_uart_periph_io_t |
List of peripheral I/O.
Peripheral I/O are guaranteed to be numbered consecutively from 0.
| typedef enum dt_uart_reg_block dt_uart_reg_block_t |
List of register blocks.
Register blocks are guaranteed to start at 0 and to be consecutively numbered.
| typedef enum dt_uart_reset dt_uart_reset_t |
List of reset ports.
Reset ports are guaranteed to be numbered consecutively from 0.
| enum dt_uart |
| enum dt_uart_alert |
| enum dt_uart_clock |
| enum dt_uart_irq |
List of IRQs.
IRQs are guaranteed to be numbered consecutively from 0.
| enum dt_uart_memory |
| enum dt_uart_periph_io |
| enum dt_uart_reg_block |
| enum dt_uart_reset |
| dt_uart_alert_t dt_uart_alert_from_alert_id | ( | dt_uart_t | dt, |
| dt_alert_id_t | alert ) |
Convert a global alert ID to a local uart alert type.
| dt | Instance of uart. |
| alert | A global alert ID that belongs to this instance. |
kDtUartAlertCount.Note: This function assumes that the global alert ID belongs to the instance of uart passed in parameter. In other words, it must be the case that dt_uart_instance_id(dt) == dt_alert_id_to_instance_id(alert). Otherwise, this function will return kDtUartAlertCount.
| dt_alert_id_t dt_uart_alert_to_alert_id | ( | dt_uart_t | dt, |
| dt_uart_alert_t | alert ) |
Get the alert ID of a uart alert for a given instance.
Note: This function only makes sense if the instance is connected to the Alert Handler. For any instances where the instance is not connected, the return value is unspecified.
| dt | Instance of uart. |
| alert | A uart alert. |
| dt_clock_t dt_uart_clock | ( | dt_uart_t | dt, |
| dt_uart_clock_t | clk ) |
| dt_uart_t dt_uart_from_instance_id | ( | dt_instance_id_t | inst_id | ) |
Get the uart instance from an instance ID.
For example, dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3.
| inst_id | Instance ID. |
Note: This function only makes sense if the instance ID has device type uart, otherwise the returned value is unspecified.
| dt_instance_id_t dt_uart_instance_id | ( | dt_uart_t | dt | ) |
| dt_uart_irq_t dt_uart_irq_from_plic_id | ( | dt_uart_t | dt, |
| dt_plic_irq_id_t | irq ) |
Convert a global IRQ ID to a local uart IRQ type.
| dt | Instance of uart. |
| irq | A PLIC ID that belongs to this instance. |
kDtUartIrqCount.Note: This function assumes that the PLIC ID belongs to the instance of uart passed in parameter. In other words, it must be the case that dt_uart_instance_id(dt) == dt_plic_id_to_instance_id(irq). Otherwise, this function will return kDtUartIrqCount.
| dt_plic_irq_id_t dt_uart_irq_to_plic_id | ( | dt_uart_t | dt, |
| dt_uart_irq_t | irq ) |
| uint32_t dt_uart_memory_base | ( | dt_uart_t | dt, |
| dt_uart_memory_t | mem ) |
| uint32_t dt_uart_memory_size | ( | dt_uart_t | dt, |
| dt_uart_memory_t | mem ) |
| dt_periph_io_t dt_uart_periph_io | ( | dt_uart_t | dt, |
| dt_uart_periph_io_t | sig ) |
| uint32_t dt_uart_reg_block | ( | dt_uart_t | dt, |
| dt_uart_reg_block_t | reg_block ) |
| dt_reset_t dt_uart_reset | ( | dt_uart_t | dt, |
| dt_uart_reset_t | rst ) |