blob: 672a2f904a2284dc008c828dc440d16e6807f308 [file] [log] [blame]
/****************************************************************************
* arch/risc-v/src/mpfs/hardware/mpfs_uart.h
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __ARCH_RISCV_SRC_MPFS_HARDWARE_MPFS_UART_H
#define __ARCH_RISCV_SRC_MPFS_HARDWARE_MPFS_UART_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include "hardware/mpfs_memorymap.h"
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
/* Register offsets *********************************************************/
#define MPFS_UART_RBR_OFFSET 0x0000 /* UART Receive Buffer Register */
#define MPFS_UART_THR_OFFSET 0x0000 /* UART Transmit Holding Register */
#define MPFS_UART_DLL_OFFSET 0x0000 /* UART Divisor Latch Low Register */
#define MPFS_UART_DLH_OFFSET 0x0004 /* UART Divisor Latch High Register */
#define MPFS_UART_IER_OFFSET 0x0004 /* UART Interrupt Enable Register */
#define MPFS_UART_IIR_OFFSET 0x0008 /* UART Interrupt Identity Register */
#define MPFS_UART_FCR_OFFSET 0x0008 /* UART FIFO Control Register */
#define MPFS_UART_LCR_OFFSET 0x000c /* UART Line Control Register */
#define MPFS_UART_MCR_OFFSET 0x0010 /* UART Modem Control Register */
#define MPFS_UART_LSR_OFFSET 0x0014 /* UART Line Status Register */
#define MPFS_UART_MSR_OFFSET 0x0018 /* UART Modem Status Register */
#define MPFS_UART_SCH_OFFSET 0x001c /* UART Scratch Register */
#define MPFS_UART_IEM_OFFSET 0x0024 /* UART Multi-mode interrupt enable register */
#define MPFS_UART_IIM_OFFSET 0x0028 /* UART Multi-mode interrupt identification register */
#define MPFS_UART_MM0_OFFSET 0x0030 /* UART Multi-mode control register 0 */
#define MPFS_UART_MM1_OFFSET 0x0034 /* UART Multi-mode control register 1 */
#define MPFS_UART_MM2_OFFSET 0x0038 /* UART Multi-mode control register 2 */
#define MPFS_UART_DFR_OFFSET 0x003C /* UART Fractional divisor register */
#define MPFS_UART_GFR_OFFSET 0x0044 /* UART Glitch filter register */
#define MPFS_UART_TTG_OFFSET 0x0048 /* UART Transmitter time guard register */
#define MPFS_UART_RTO_OFFSET 0x004C /* UART Receiver time-out register */
#define MPFS_UART_ADR_OFFSET 0x0050 /* UART Address register */
/* Register bit field definitions *******************************************/
/* UART Receive Buffer Register */
#define UART_RBR_MASK 0x000000ff
/* UART Transmit Holding Register */
#define UART_THR_MASK 0x000000ff
/* UART Divisor Latch Low Register */
#define UART_DLL_MASK 0x000000ff
/* UART Divisor Latch High Register */
#define UART_DLH_MASK 0x000000ff
/* UART Interrupt Enable Register */
#define UART_IER_ERBFI (1 << 0) /* Bit 0: Enable Received Data Available Interrupt */
#define UART_IER_ETBEI (1 << 1) /* Bit 1: Enable Transmit Holding Register Empty Interrupt */
#define UART_IER_ELSI (1 << 2) /* Bit 2: Enable Receiver Line Status Interrupt */
#define UART_IER_EDSSI (1 << 3) /* Bit 3: Enable Modem Status Interrupt */
#define UART_IER_ALLIE 0x0000008f
/* UART Interrupt Identity Register */
#define UART_IIR_IID_SHIFT (0) /* Bits: 0-3: Interrupt ID */
#define UART_IIR_IID_MASK (15 << UART_IIR_IID_SHIFT)
# define UART_IIR_IID_MODEM (0 << UART_IIR_IID_SHIFT) /* Modem status */
# define UART_IIR_IID_NONE (1 << UART_IIR_IID_SHIFT) /* No interrupt pending */
# define UART_IIR_IID_TXEMPTY (2 << UART_IIR_IID_SHIFT) /* THR empty */
# define UART_IIR_IID_RECV (4 << UART_IIR_IID_SHIFT) /* Received data available */
# define UART_IIR_IID_LINESTATUS (6 << UART_IIR_IID_SHIFT) /* Receiver line status */
# define UART_IIR_IID_TIMEOUT (12 << UART_IIR_IID_SHIFT) /* Character timeout */
#define UART_IIR_FEFLAG_SHIFT (6) /* Bits 6-7: FIFOs Enable Flag */
#define UART_IIR_FEFLAG_MASK (3 << UART_IIR_FEFLAG_SHIFT)
# define UART_IIR_FEFLAG_DISABLE (0 << UART_IIR_FEFLAG_SHIFT)
# define UART_IIR_FEFLAG_ENABLE (3 << UART_IIR_FEFLAG_SHIFT)
/* UART FIFO Control Register */
#define UART_FCR_FIFOE (1 << 0) /* Bit 0: Enable FIFOs */
#define UART_FCR_RFIFOR (1 << 1) /* Bit 1: RCVR FIFO Reset */
#define UART_FCR_XFIFOR (1 << 2) /* Bit 2: XMIT FIFO reset */
#define UART_FCR_DMAM (1 << 3) /* Bit 3: DMA mode */
#define UART_FCR_TFT_SHIFT (4) /* Bits 4-5: TX Empty Trigger */
#define UART_FCR_TFT_MASK (3 << UART_FCR_TFT_SHIFT)
# define UART_FCR_TFT_EMPTY (0 << UART_FCR_TFT_SHIFT) /* FIFO empty */
# define UART_FCR_TFT_TWO (1 << UART_FCR_TFT_SHIFT) /* 2 characters in the FIFO */
# define UART_FCR_TFT_QUARTER (2 << UART_FCR_TFT_SHIFT) /* FIFO 1/4 full */
# define UART_FCR_TFT_HALF (3 << UART_FCR_TFT_SHIFT) /* FIFO 1/2 full */
#define UART_FCR_RT_SHIFT (6) /* Bits 6-7: RCVR Trigger */
#define UART_FCR_RT_MASK (3 << UART_FCR_RT_SHIFT)
# define UART_FCR_RT_ONE (0 << UART_FCR_RT_SHIFT) /* 1 character in the FIFO */
# define UART_FCR_RT_QUARTER (1 << UART_FCR_RT_SHIFT) /* FIFO 1/4 full */
# define UART_FCR_RT_HALF (2 << UART_FCR_RT_SHIFT) /* FIFO 1/2 full */
# define UART_FCR_RT_MINUS2 (3 << UART_FCR_RT_SHIFT) /* FIFO-2 less than full */
/* UART Line Control Register */
#define UART_LCR_DLS_SHIFT (0) /* Bits 0-1: Data Length Select */
#define UART_LCR_DLS_MASK (3 << UART_LCR_DLS_SHIFT)
# define UART_LCR_DLS_5BITS (0 << UART_LCR_DLS_SHIFT) /* 5 bits */
# define UART_LCR_DLS_6BITS (1 << UART_LCR_DLS_SHIFT) /* 6 bits */
# define UART_LCR_DLS_7BITS (2 << UART_LCR_DLS_SHIFT) /* 7 bits */
# define UART_LCR_DLS_8BITS (3 << UART_LCR_DLS_SHIFT) /* 8 bits */
#define UART_LCR_STOP (1 << 2) /* Bit 2: Number of stop bits */
#define UART_LCR_PEN (1 << 3) /* Bit 3: Parity Enable */
#define UART_LCR_EPS (1 << 4) /* Bit 4: Even Parity Select */
#define UART_LCR_BC (1 << 6) /* Bit 6: Break Control Bit */
#define UART_LCR_DLAB (1 << 7) /* Bit 7: Divisor Latch Access Bit */
/* UART Modem Control Register */
#define UART_MCR_DTR (1 << 0) /* Bit 0: Data Terminal Ready */
#define UART_MCR_RTS (1 << 1) /* Bit 1: Request to Send */
#define UART_MCR_LOOP (1 << 4) /* Bit 4: Loop Back Mode */
#define UART_MCR_AFCE (1 << 5) /* Bit 5: Auto Flow Control Enable */
#define UART_MCR_SIRE (1 << 6) /* Bit 6: SIR Mode Enable */
/* UART Line Status Register */
#define UART_LSR_DR (1 << 0) /* Bit 0: Data Ready */
#define UART_LSR_OE (1 << 1) /* Bit 1: Overrun Error */
#define UART_LSR_PE (1 << 2) /* Bit 2: Parity Error */
#define UART_LSR_FE (1 << 3) /* Bit 3: Framing Error */
#define UART_LSR_BI (1 << 4) /* Bit 4: Break Interrupt */
#define UART_LSR_THRE (1 << 5) /* Bit 5: TX Holding Register Empty */
#define UART_LSR_TEMT (1 << 6) /* Bit 6: Transmitter Empty */
#define UART_LSR_FIFOERR (1 << 7) /* Bit 7: RX Data Error in FIFO */
/* UART Modem Status Register */
#define UART_MSR_DCTS (1 << 0) /* Bit 0: Delta Clear to Send */
#define UART_MSR_DDSR (1 << 1) /* Bit 1: Delta Data Set Ready */
#define UART_MSR_TERI (1 << 2) /* Bit 2: Trailing Edge Ring Indicator */
#define UART_MSR_DDCD (1 << 3) /* Bit 3: Delta Data Carrier Detect */
#define UART_MSR_CTS (1 << 4) /* Bit 4: Line State of Clear To Send */
#define UART_MSR_DSR (1 << 5) /* Bit 5: Line State of Data Set Ready */
#define UART_MSR_RI (1 << 6) /* Bit 6: Line State of Ring Indicator */
#define UART_MSR_DCD (1 << 7) /* Bit 7: Line State of Data Carrier Detect */
/* UART Scratch Register */
#define UART_SCH_MASK 0x000000ff
/* UART Status Register */
#define UART_USR_BUSY (1 << 0) /* Bit 0: UART Busy Bit */
#define UART_USR_TFNF (1 << 1) /* Bit 1: Transmit FIFO Not Full */
#define UART_USR_TFE (1 << 2) /* Bit 2: Transmit FIFO Empty */
#define UART_USR_RFNE (1 << 3) /* Bit 3: Receive FIFO Not Empty */
#define UART_USR_RFF (1 << 4) /* Bit 4: Receive FIFO Full */
/* UART Transmit FIFO Level */
#define UART_TFL_SHIFT (0) /* Bits 0-6: Transmit FIFO Level */
#define UART_TFL_MASK (0x7f << UART_TFL_SHIFT)
# define UART_TFL(n) ((uint32_t)(n) << UART_TFL_SHIFT)
/* UART Receive FIFO Level */
#define UART_RFL_SHIFT (0) /* Bits 0-6: Receive FIFO Level */
#define UART_RFL_MASK (0x7f << UART_RFL_SHIFT)
# define UART_RFL(n) ((uint32_t)(n) << UART_RFL_SHIFT)
/* Multimode register 0 */
#define UART_MM0_ELIN (1 << 3) /* Bit 3: Enable LIN header detection */
#define UART_MM0_ETIG (1 << 5) /* Bit 5: Enable transmitter time guard */
#define UART_MM0_ERTO (1 << 6) /* Bit 6: Enable receiver time-out */
#define UART_MM0_EFBR (1 << 7) /* Bit 7: Enable fractional baud rate mode */
#endif /* __ARCH_RISCV_SRC_MPFS_HARDWARE_MPFS_UART_H */