dt_uart.h

Go to the documentation of this file.

// Copyright lowRISC contributors (OpenTitan project).
// Licensed under the Apache License, Version 2.0, see LICENSE for details.
// SPDX-License-Identifier: Apache-2.0
//
// Device table API auto-generated by `dtgen`
 
#ifndef OPENTITAN_DT_UART_H_
#define OPENTITAN_DT_UART_H_
 
#ifdef __cplusplus
extern "C" {
#endif  // __cplusplus
 
/**
 * @file
 * @brief Device Tables (DT) for IP uart and top darjeeling.
 *
 * This file contains the type definitions and global functions of the uart.
 */
 
#include "hw/top/dt/dt_api.h"
#include <stdint.h>
 
 
 
/**
 * List of instances.
 */
typedef enum dt_uart {
  kDtUart0 = 0, /**< uart0 */
  kDtUartFirst = 0, /**< \internal First instance */
  kDtUartCount = 1, /**< \internal Number of instances */
} dt_uart_t;
 
/**
 * List of register blocks.
 *
 * Register blocks are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_uart_reg_block {
  kDtUartRegBlockCore = 0, /**<  */
  kDtUartRegBlockCount = 1, /**< \internal Number of register blocks */
} dt_uart_reg_block_t;
 
/** Primary register block (associated with the "primary" set of registers that control the IP). */
static const dt_uart_reg_block_t kDtUartRegBlockPrimary = kDtUartRegBlockCore;
 
/**
 * List of memories.
 *
 * Memories are guaranteed to start at 0 and to be consecutively numbered.
 */
typedef enum dt_uart_memory {
  kDtUartMemoryCount = 0, /**< \internal Number of memories */
} dt_uart_memory_t;
 
/**
 * List of IRQs.
 *
 * IRQs are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_uart_irq {
  kDtUartIrqTxWatermark = 0, /**< raised if the transmit FIFO is past the high-water mark. */
  kDtUartIrqRxWatermark = 1, /**< raised if the receive FIFO is past the high-water mark. */
  kDtUartIrqTxDone = 2, /**< raised if the transmit FIFO has emptied and no transmit is ongoing. */
  kDtUartIrqRxOverflow = 3, /**< raised if the receive FIFO has overflowed. */
  kDtUartIrqRxFrameErr = 4, /**< raised if a framing error has been detected on receive. */
  kDtUartIrqRxBreakErr = 5, /**< raised if break condition has been detected on receive. */
  kDtUartIrqRxTimeout = 6, /**< raised if RX FIFO has characters remaining in the FIFO without being
retrieved for the programmed time period. */
  kDtUartIrqRxParityErr = 7, /**< raised if the receiver has detected a parity error. */
  kDtUartIrqTxEmpty = 8, /**< raised if the transmit FIFO is empty. */
  kDtUartIrqCount = 9, /**< \internal Number of IRQs */
} dt_uart_irq_t;
 
/**
 * List of Alerts.
 *
 * Alerts are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_uart_alert {
  kDtUartAlertFatalFault = 0, /**< This fatal alert is triggered when a fatal TL-UL bus integrity fault is detected. */
  kDtUartAlertCount = 1, /**< \internal Number of Alerts */
} dt_uart_alert_t;
 
/**
 * List of clock ports.
 *
 * Clock ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_uart_clock {
  kDtUartClockClk = 0, /**< Clock port clk_i */
  kDtUartClockCount = 1, /**< \internal Number of clock ports */
} dt_uart_clock_t;
 
/**
 * List of reset ports.
 *
 * Reset ports are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_uart_reset {
  kDtUartResetRst = 0, /**< Reset port rst_ni */
  kDtUartResetCount = 1, /**< \internal Number of reset ports */
} dt_uart_reset_t;
 
/**
 * List of peripheral I/O.
 *
 * Peripheral I/O are guaranteed to be numbered consecutively from 0.
 */
typedef enum dt_uart_periph_io {
  kDtUartPeriphIoRx = 0, /**<  */
  kDtUartPeriphIoTx = 1, /**<  */
  kDtUartPeriphIoCount = 2, /**< \internal Number of peripheral I/O */
} dt_uart_periph_io_t;
 
/**
 * List of supported hardware features.
 */
#define OPENTITAN_UART_HAS_PARITY 1
#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
 
 
 
/**
 * Get the uart instance from an instance ID
 *
 * For example, `dt_uart_from_instance_id(kDtInstanceIdUart3) == kDtUart3`.
 *
 * @param inst_id Instance ID.
 * @return A uart instance.
 *
 * **Note:** This function only makes sense if the instance ID has device type uart,
 * otherwise the returned value is unspecified.
 */
dt_uart_t dt_uart_from_instance_id(dt_instance_id_t inst_id);
 
/**
 * Get the instance ID of an instance.
 *
 * @param dt Instance of uart.
 * @return The instance ID of that instance.
 */
dt_instance_id_t dt_uart_instance_id(dt_uart_t dt);
 
/**
 * Get the register base address of an instance.
 *
 * @param dt Instance of uart.
 * @param reg_block The register block requested.
 * @return The register base address of the requested block.
 */
uint32_t dt_uart_reg_block(
    dt_uart_t dt,
    dt_uart_reg_block_t reg_block);
 
/**
 * Get the primary register base address of an instance.
 *
 * This is just a convenience function, equivalent to
 * `dt_uart_reg_block(dt, kDtUartRegBlockCore)`
 *
 * @param dt Instance of uart.
 * @return The register base address of the primary register block.
 */
static inline uint32_t dt_uart_primary_reg_block(
    dt_uart_t dt) {
  return dt_uart_reg_block(dt, kDtUartRegBlockCore);
}
 
/**
 * Get the base address of a memory.
 *
 * @param dt Instance of uart.
 * @param mem The memory requested.
 * @return The base address of the requested memory.
 */
uint32_t dt_uart_memory_base(
    dt_uart_t dt,
    dt_uart_memory_t mem);
 
/**
 * Get the size of a memory.
 *
 * @param dt Instance of uart.
 * @param mem The memory requested.
 * @return The size of the requested memory.
 */
uint32_t dt_uart_memory_size(
    dt_uart_t dt,
    dt_uart_memory_t mem);
 
/**
 * Get the PLIC ID of a uart IRQ for a given instance.
 *
 * If the instance is not connected to the PLIC, this function
 * will return `kDtPlicIrqIdNone`.
 *
 * @param dt Instance of uart.
 * @param irq A uart IRQ.
 * @return The PLIC ID of the IRQ of this instance.
 */
dt_plic_irq_id_t dt_uart_irq_to_plic_id(
    dt_uart_t dt,
    dt_uart_irq_t irq);
 
/**
 * Convert a global IRQ ID to a local uart IRQ type.
 *
 * @param dt Instance of uart.
 * @param irq A PLIC ID that belongs to this instance.
 * @return The uart IRQ, or `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_uart_irq_t dt_uart_irq_from_plic_id(
    dt_uart_t dt,
    dt_plic_irq_id_t irq);
 
 
/**
 * 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.
 *
 * @param dt Instance of uart.
 * @param alert A uart alert.
 * @return The Alert Handler alert ID of the alert of this instance.
 */
dt_alert_id_t dt_uart_alert_to_alert_id(
    dt_uart_t dt,
    dt_uart_alert_t alert);
 
/**
 * Convert a global alert ID to a local uart alert type.
 *
 * @param dt Instance of uart.
 * @param alert A global alert ID that belongs to this instance.
 * @return The uart alert, or `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_uart_alert_t dt_uart_alert_from_alert_id(
    dt_uart_t dt,
    dt_alert_id_t alert);
 
 
/**
 * Get the peripheral I/O description of an instance.
 *
 * @param dt Instance of uart.
 * @param sig Requested peripheral I/O.
 * @return Description of the requested peripheral I/O for this instance.
 */
dt_periph_io_t dt_uart_periph_io(
    dt_uart_t dt,
    dt_uart_periph_io_t sig);
 
/**
 * Get the clock signal connected to a clock port of an instance.
 *
 * @param dt Instance of uart.
 * @param clk Clock port.
 * @return Clock signal.
 */
dt_clock_t dt_uart_clock(
    dt_uart_t dt,
    dt_uart_clock_t clk);
 
/**
 * Get the reset signal connected to a reset port of an instance.
 *
 * @param dt Instance of uart.
 * @param rst Reset port.
 * @return Reset signal.
 */
dt_reset_t dt_uart_reset(
    dt_uart_t dt,
    dt_uart_reset_t rst);
 
 
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  // OPENTITAN_DT_UART_H_