OpenTitan UART
UART documentation
Architecture
RTL responsibilities
FIFO sizing
Data flow
Serial protocol
Transmit path
Receive path
RTL API reference
Register package
Integration wrapper
UART core
Transmit datapath
Receive datapath
Generated register block
How the example uses sphinx-svdomain
Targeted autodoc
Cross-references
Syntax-only boundary
OpenTitan UART
Index
Index
U
U
uart (module)
uart.alert_rx_i (port)
uart.alert_tx_o (port)
uart.AlertAsyncOn (parameter)
uart.AlertSkewCycles (parameter)
uart.cio_rx_i (port)
uart.cio_tx_en_o (port)
uart.cio_tx_o (port)
uart.clk_i (port)
uart.EnableRacl (parameter)
uart.intr_rx_break_err_o (port)
uart.intr_rx_frame_err_o (port)
uart.intr_rx_overflow_o (port)
uart.intr_rx_parity_err_o (port)
uart.intr_rx_timeout_o (port)
uart.intr_rx_watermark_o (port)
uart.intr_tx_done_o (port)
uart.intr_tx_empty_o (port)
uart.intr_tx_watermark_o (port)
uart.lsio_trigger_o (port)
uart.racl_error_o (port)
uart.racl_policies_i (port)
uart.RaclErrorRsp (parameter)
uart.RaclPolicySelVec (parameter)
uart.rst_ni (port)
uart.tl_i (port)
uart.tl_o (port)
uart_core (module)
uart_core.break_st_e (enum)
uart_core.break_st_e.BRK_CHK (enumerator)
uart_core.break_st_e.BRK_WAIT (enumerator)
uart_core.clk_i (port)
uart_core.hw2reg (port)
uart_core.intr_rx_break_err_o (port)
uart_core.intr_rx_frame_err_o (port)
uart_core.intr_rx_overflow_o (port)
uart_core.intr_rx_parity_err_o (port)
uart_core.intr_rx_timeout_o (port)
uart_core.intr_rx_watermark_o (port)
uart_core.intr_tx_done_o (port)
uart_core.intr_tx_empty_o (port)
uart_core.intr_tx_watermark_o (port)
uart_core.lsio_trigger_o (port)
uart_core.NcoWidth (localparam)
uart_core.reg2hw (port)
uart_core.rst_ni (port)
uart_core.rx (port)
uart_core.RxFifoDepthW (localparam)
uart_core.tx (port)
uart_core.TxFifoDepthW (localparam)
uart_reg_pkg (package)
uart_reg_pkg::BlockAw (parameter)
uart_reg_pkg::NumAlerts (parameter)
uart_reg_pkg::NumRegs (parameter)
uart_reg_pkg::RxFifoDepth (parameter)
uart_reg_pkg::TxFifoDepth (parameter)
uart_reg_pkg::uart_alert_idx_t (enum)
uart_reg_pkg::uart_alert_idx_t.AlertFatalFaultIdx (enumerator)
uart_reg_pkg::UART_ALERT_TEST_FATAL_FAULT_RESVAL (parameter)
uart_reg_pkg::UART_ALERT_TEST_OFFSET (parameter)
uart_reg_pkg::UART_ALERT_TEST_RESVAL (parameter)
uart_reg_pkg::UART_CTRL_OFFSET (parameter)
uart_reg_pkg::UART_FIFO_CTRL_OFFSET (parameter)
uart_reg_pkg::UART_FIFO_STATUS_OFFSET (parameter)
uart_reg_pkg::UART_FIFO_STATUS_RESVAL (parameter)
uart_reg_pkg::uart_hw2reg_fifo_ctrl_reg_t (struct)
uart_reg_pkg::uart_hw2reg_fifo_ctrl_reg_t.rxilvl (field)
uart_reg_pkg::uart_hw2reg_fifo_ctrl_reg_t.txilvl (field)
uart_reg_pkg::uart_hw2reg_fifo_status_reg_t (struct)
uart_reg_pkg::uart_hw2reg_fifo_status_reg_t.rxlvl (field)
uart_reg_pkg::uart_hw2reg_fifo_status_reg_t.txlvl (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t (struct)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.rx_break_err (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.rx_frame_err (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.rx_overflow (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.rx_parity_err (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.rx_timeout (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.rx_watermark (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.tx_done (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.tx_empty (field)
uart_reg_pkg::uart_hw2reg_intr_state_reg_t.tx_watermark (field)
uart_reg_pkg::uart_hw2reg_rdata_reg_t (struct)
uart_reg_pkg::uart_hw2reg_rdata_reg_t.d (field)
uart_reg_pkg::uart_hw2reg_status_reg_t (struct)
uart_reg_pkg::uart_hw2reg_status_reg_t.rxempty (field)
uart_reg_pkg::uart_hw2reg_status_reg_t.rxfull (field)
uart_reg_pkg::uart_hw2reg_status_reg_t.rxidle (field)
uart_reg_pkg::uart_hw2reg_status_reg_t.txempty (field)
uart_reg_pkg::uart_hw2reg_status_reg_t.txfull (field)
uart_reg_pkg::uart_hw2reg_status_reg_t.txidle (field)
uart_reg_pkg::uart_hw2reg_t (struct)
uart_reg_pkg::uart_hw2reg_t.fifo_ctrl (field)
uart_reg_pkg::uart_hw2reg_t.fifo_status (field)
uart_reg_pkg::uart_hw2reg_t.intr_state (field)
uart_reg_pkg::uart_hw2reg_t.rdata (field)
uart_reg_pkg::uart_hw2reg_t.status (field)
uart_reg_pkg::uart_hw2reg_t.val (field)
uart_reg_pkg::uart_hw2reg_val_reg_t (struct)
uart_reg_pkg::uart_hw2reg_val_reg_t.d (field)
uart_reg_pkg::uart_id_e (enum)
uart_reg_pkg::uart_id_e.UART_ALERT_TEST (enumerator)
uart_reg_pkg::uart_id_e.UART_CTRL (enumerator)
uart_reg_pkg::uart_id_e.UART_FIFO_CTRL (enumerator)
uart_reg_pkg::uart_id_e.UART_FIFO_STATUS (enumerator)
uart_reg_pkg::uart_id_e.UART_INTR_ENABLE (enumerator)
uart_reg_pkg::uart_id_e.UART_INTR_STATE (enumerator)
uart_reg_pkg::uart_id_e.UART_INTR_TEST (enumerator)
uart_reg_pkg::uart_id_e.UART_OVRD (enumerator)
uart_reg_pkg::uart_id_e.UART_RDATA (enumerator)
uart_reg_pkg::uart_id_e.UART_STATUS (enumerator)
uart_reg_pkg::uart_id_e.UART_TIMEOUT_CTRL (enumerator)
uart_reg_pkg::uart_id_e.UART_VAL (enumerator)
uart_reg_pkg::uart_id_e.UART_WDATA (enumerator)
uart_reg_pkg::UART_INTR_ENABLE_OFFSET (parameter)
uart_reg_pkg::UART_INTR_STATE_OFFSET (parameter)
uart_reg_pkg::UART_INTR_TEST_OFFSET (parameter)
uart_reg_pkg::UART_INTR_TEST_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_RX_BREAK_ERR_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_RX_FRAME_ERR_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_RX_OVERFLOW_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_RX_PARITY_ERR_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_RX_TIMEOUT_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_RX_WATERMARK_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_TX_DONE_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_TX_EMPTY_RESVAL (parameter)
uart_reg_pkg::UART_INTR_TEST_TX_WATERMARK_RESVAL (parameter)
uart_reg_pkg::UART_OVRD_OFFSET (parameter)
uart_reg_pkg::UART_PERMIT (parameter)
uart_reg_pkg::UART_RDATA_OFFSET (parameter)
uart_reg_pkg::UART_RDATA_RESVAL (parameter)
uart_reg_pkg::uart_reg2hw_alert_test_reg_t (struct)
uart_reg_pkg::uart_reg2hw_alert_test_reg_t.q (field)
uart_reg_pkg::uart_reg2hw_alert_test_reg_t.qe (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t (struct)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.llpbk (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.nco (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.nf (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.parity_en (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.parity_odd (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.rx (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.rxblvl (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.slpbk (field)
uart_reg_pkg::uart_reg2hw_ctrl_reg_t.tx (field)
uart_reg_pkg::uart_reg2hw_fifo_ctrl_reg_t (struct)
uart_reg_pkg::uart_reg2hw_fifo_ctrl_reg_t.rxilvl (field)
uart_reg_pkg::uart_reg2hw_fifo_ctrl_reg_t.rxrst (field)
uart_reg_pkg::uart_reg2hw_fifo_ctrl_reg_t.txilvl (field)
uart_reg_pkg::uart_reg2hw_fifo_ctrl_reg_t.txrst (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t (struct)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.rx_break_err (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.rx_frame_err (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.rx_overflow (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.rx_parity_err (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.rx_timeout (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.rx_watermark (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.tx_done (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.tx_empty (field)
uart_reg_pkg::uart_reg2hw_intr_enable_reg_t.tx_watermark (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t (struct)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.rx_break_err (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.rx_frame_err (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.rx_overflow (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.rx_parity_err (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.rx_timeout (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.rx_watermark (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.tx_done (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.tx_empty (field)
uart_reg_pkg::uart_reg2hw_intr_state_reg_t.tx_watermark (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t (struct)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.rx_break_err (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.rx_frame_err (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.rx_overflow (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.rx_parity_err (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.rx_timeout (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.rx_watermark (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.tx_done (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.tx_empty (field)
uart_reg_pkg::uart_reg2hw_intr_test_reg_t.tx_watermark (field)
uart_reg_pkg::uart_reg2hw_ovrd_reg_t (struct)
uart_reg_pkg::uart_reg2hw_ovrd_reg_t.txen (field)
uart_reg_pkg::uart_reg2hw_ovrd_reg_t.txval (field)
uart_reg_pkg::uart_reg2hw_rdata_reg_t (struct)
uart_reg_pkg::uart_reg2hw_rdata_reg_t.q (field)
uart_reg_pkg::uart_reg2hw_rdata_reg_t.re (field)
uart_reg_pkg::uart_reg2hw_status_reg_t (struct)
uart_reg_pkg::uart_reg2hw_status_reg_t.rxempty (field)
uart_reg_pkg::uart_reg2hw_status_reg_t.rxfull (field)
uart_reg_pkg::uart_reg2hw_status_reg_t.rxidle (field)
uart_reg_pkg::uart_reg2hw_status_reg_t.txempty (field)
uart_reg_pkg::uart_reg2hw_status_reg_t.txfull (field)
uart_reg_pkg::uart_reg2hw_status_reg_t.txidle (field)
uart_reg_pkg::uart_reg2hw_t (struct)
uart_reg_pkg::uart_reg2hw_t.alert_test (field)
uart_reg_pkg::uart_reg2hw_t.ctrl (field)
uart_reg_pkg::uart_reg2hw_t.fifo_ctrl (field)
uart_reg_pkg::uart_reg2hw_t.intr_enable (field)
uart_reg_pkg::uart_reg2hw_t.intr_state (field)
uart_reg_pkg::uart_reg2hw_t.intr_test (field)
uart_reg_pkg::uart_reg2hw_t.ovrd (field)
uart_reg_pkg::uart_reg2hw_t.rdata (field)
uart_reg_pkg::uart_reg2hw_t.status (field)
uart_reg_pkg::uart_reg2hw_t.timeout_ctrl (field)
uart_reg_pkg::uart_reg2hw_t.wdata (field)
uart_reg_pkg::uart_reg2hw_timeout_ctrl_reg_t (struct)
uart_reg_pkg::uart_reg2hw_timeout_ctrl_reg_t.en (field)
uart_reg_pkg::uart_reg2hw_timeout_ctrl_reg_t.val (field)
uart_reg_pkg::uart_reg2hw_wdata_reg_t (struct)
uart_reg_pkg::uart_reg2hw_wdata_reg_t.q (field)
uart_reg_pkg::uart_reg2hw_wdata_reg_t.qe (field)
uart_reg_pkg::UART_STATUS_OFFSET (parameter)
uart_reg_pkg::UART_STATUS_RESVAL (parameter)
uart_reg_pkg::UART_STATUS_RXEMPTY_RESVAL (parameter)
uart_reg_pkg::UART_STATUS_RXIDLE_RESVAL (parameter)
uart_reg_pkg::UART_STATUS_TXEMPTY_RESVAL (parameter)
uart_reg_pkg::UART_STATUS_TXIDLE_RESVAL (parameter)
uart_reg_pkg::UART_TIMEOUT_CTRL_OFFSET (parameter)
uart_reg_pkg::UART_VAL_OFFSET (parameter)
uart_reg_pkg::UART_VAL_RESVAL (parameter)
uart_reg_pkg::UART_WDATA_OFFSET (parameter)
uart_reg_top (module)
uart_reg_top.AW (localparam)
uart_reg_top.clk_i (port)
uart_reg_top.DBW (localparam)
uart_reg_top.DW (localparam)
uart_reg_top.EnableRacl (parameter)
uart_reg_top.hw2reg (port)
uart_reg_top.intg_err_o (port)
uart_reg_top.racl_error_o (port)
uart_reg_top.racl_policies_i (port)
uart_reg_top.RaclErrorRsp (parameter)
uart_reg_top.RaclPolicySelVec (parameter)
uart_reg_top.reg2hw (port)
uart_reg_top.rst_ni (port)
uart_reg_top.tl_i (port)
uart_reg_top.tl_o (port)
uart_rx (module)
uart_rx.clk_i (port)
uart_rx.frame_err (port)
uart_rx.idle (port)
uart_rx.parity_enable (port)
uart_rx.parity_odd (port)
uart_rx.rst_ni (port)
uart_rx.rx (port)
uart_rx.rx_data (port)
uart_rx.rx_enable (port)
uart_rx.rx_parity_err (port)
uart_rx.rx_valid (port)
uart_rx.tick_baud (port)
uart_rx.tick_baud_x16 (port)
uart_tx (module)
uart_tx.clk_i (port)
uart_tx.idle (port)
uart_tx.parity_enable (port)
uart_tx.rst_ni (port)
uart_tx.tick_baud_x16 (port)
uart_tx.tx (port)
uart_tx.tx_enable (port)
uart_tx.wr (port)
uart_tx.wr_data (port)
uart_tx.wr_parity (port)