root/usr/src/boot/include/dev/ic/ns16550.h
/*-
 * Copyright (c) 1991 The Regents of the University of California.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      from: @(#)ns16550.h     7.1 (Berkeley) 5/9/91
 * $FreeBSD$
 */

/*
 * NS8250... UART registers.
 */

/* 8250 registers #[0-6]. */

#define com_data        0       /* data register (R/W) */
#define REG_DATA        com_data

#define com_ier         1       /* interrupt enable register (W) */
#define REG_IER         com_ier
#define IER_ERXRDY      0x1
#define IER_ETXRDY      0x2
#define IER_ERLS        0x4
#define IER_EMSC        0x8

#define IER_BITS        "\20\1ERXRDY\2ETXRDY\3ERLS\4EMSC"

#define com_iir         2       /* interrupt identification register (R) */
#define REG_IIR         com_iir
#define IIR_IMASK       0xf
#define IIR_RXTOUT      0xc
#define IIR_BUSY        0x7
#define IIR_RLS         0x6
#define IIR_RXRDY       0x4
#define IIR_TXRDY       0x2
#define IIR_NOPEND      0x1
#define IIR_MLSC        0x0
#define IIR_FIFO_MASK   0xc0    /* set if FIFOs are enabled */

#define IIR_BITS        "\20\1NOPEND\2TXRDY\3RXRDY"

#define com_lcr         3       /* line control register (R/W) */
#define com_cfcr        com_lcr /* character format control register (R/W) */
#define REG_LCR         com_lcr
#define LCR_DLAB        0x80
#define CFCR_DLAB       LCR_DLAB
#define LCR_EFR_ENABLE  0xbf    /* magic to enable EFR on 16650 up */
#define CFCR_EFR_ENABLE LCR_EFR_ENABLE
#define LCR_SBREAK      0x40
#define CFCR_SBREAK     LCR_SBREAK
#define LCR_PZERO       0x30
#define CFCR_PZERO      LCR_PZERO
#define LCR_PONE        0x20
#define CFCR_PONE       LCR_PONE
#define LCR_PEVEN       0x10
#define CFCR_PEVEN      LCR_PEVEN
#define LCR_PODD        0x00
#define CFCR_PODD       LCR_PODD
#define LCR_PENAB       0x08
#define CFCR_PENAB      LCR_PENAB
#define LCR_STOPB       0x04
#define CFCR_STOPB      LCR_STOPB
#define LCR_8BITS       0x03
#define CFCR_8BITS      LCR_8BITS
#define LCR_7BITS       0x02
#define CFCR_7BITS      LCR_7BITS
#define LCR_6BITS       0x01
#define CFCR_6BITS      LCR_6BITS
#define LCR_5BITS       0x00
#define CFCR_5BITS      LCR_5BITS

#define com_mcr         4       /* modem control register (R/W) */
#define REG_MCR         com_mcr
#define MCR_PRESCALE    0x80    /* only available on 16650 up */
#define MCR_LOOPBACK    0x10
#define MCR_IE          0x08
#define MCR_IENABLE     MCR_IE
#define MCR_DRS         0x04
#define MCR_RTS         0x02
#define MCR_DTR         0x01

#define MCR_BITS        "\20\1DTR\2RTS\3DRS\4IE\5LOOPBACK\10PRESCALE"

#define com_lsr         5       /* line status register (R/W) */
#define REG_LSR         com_lsr
#define LSR_RCV_FIFO    0x80
#define LSR_TEMT        0x40
#define LSR_TSRE        LSR_TEMT
#define LSR_THRE        0x20
#define LSR_TXRDY       LSR_THRE
#define LSR_BI          0x10
#define LSR_FE          0x08
#define LSR_PE          0x04
#define LSR_OE          0x02
#define LSR_RXRDY       0x01
#define LSR_RCV_MASK    0x1f

#define LSR_BITS        "\20\1RXRDY\2OE\3PE\4FE\5BI\6THRE\7TEMT\10RCV_FIFO"

#define com_msr         6       /* modem status register (R/W) */
#define REG_MSR         com_msr
#define MSR_DCD         0x80
#define MSR_RI          0x40
#define MSR_DSR         0x20
#define MSR_CTS         0x10
#define MSR_DDCD        0x08
#define MSR_TERI        0x04
#define MSR_DDSR        0x02
#define MSR_DCTS        0x01

#define MSR_BITS        "\20\1DCTS\2DDSR\3TERI\4DDCD\5CTS\6DSR\7RI\10DCD"

/* 8250 multiplexed registers #[0-1].  Access enabled by LCR[7]. */
#define com_dll         0       /* divisor latch low (R/W) */
#define com_dlbl        com_dll
#define com_dlm         1       /* divisor latch high (R/W) */
#define com_dlbh        com_dlm
#define REG_DLL         com_dll
#define REG_DLH         com_dlm

/* 16450 register #7.  Not multiplexed. */
#define com_scr         7       /* scratch register (R/W) */

/* 16550 register #2.  Not multiplexed. */
#define com_fcr         2       /* FIFO control register (W) */
#define com_fifo        com_fcr
#define REG_FCR         com_fcr
#define FCR_ENABLE      0x01
#define FIFO_ENABLE     FCR_ENABLE
#define FCR_RCV_RST     0x02
#define FIFO_RCV_RST    FCR_RCV_RST
#define FCR_XMT_RST     0x04
#define FIFO_XMT_RST    FCR_XMT_RST
#define FCR_DMA         0x08
#define FIFO_DMA_MODE   FCR_DMA
#define FCR_RX_LOW      0x00
#define FIFO_RX_LOW     FCR_RX_LOW
#define FCR_RX_MEDL     0x40
#define FIFO_RX_MEDL    FCR_RX_MEDL
#define FCR_RX_MEDH     0x80
#define FIFO_RX_MEDH    FCR_RX_MEDH
#define FCR_RX_HIGH     0xc0
#define FIFO_RX_HIGH    FCR_RX_HIGH

#define FCR_BITS        "\20\1ENABLE\2RCV_RST\3XMT_RST\4DMA"

/* 16650 registers #2,[4-7].  Access enabled by LCR_EFR_ENABLE. */

#define com_efr         2       /* enhanced features register (R/W) */
#define REG_EFR         com_efr
#define EFR_CTS         0x80
#define EFR_AUTOCTS     EFR_CTS
#define EFR_RTS         0x40
#define EFR_AUTORTS     EFR_RTS
#define EFR_EFE         0x10    /* enhanced functions enable */

#define com_xon1        4       /* XON 1 character (R/W) */
#define com_xon2        5       /* XON 2 character (R/W) */
#define com_xoff1       6       /* XOFF 1 character (R/W) */
#define com_xoff2       7       /* XOFF 2 character (R/W) */

#define DW_REG_USR      31      /* DesignWare derived Uart Status Reg */
#define com_usr         39      /* Octeon 16750/16550 Uart Status Reg */
#define REG_USR         com_usr
#define USR_BUSY        1       /* Uart Busy. Serial transfer in progress */
#define USR_TXFIFO_NOTFULL 2    /* Uart TX FIFO Not full */

/* 16950 register #1.  Access enabled by ACR[7].  Also requires !LCR[7]. */
#define com_asr         1       /* additional status register (R[0-7]/W[0-1]) */

/* 16950 register #3.  R/W access enabled by ACR[7]. */
#define com_rfl         3       /* receiver fifo level (R) */

/*
 * 16950 register #4.  Access enabled by ACR[7].  Also requires
 * !LCR_EFR_ENABLE.
 */
#define com_tfl         4       /* transmitter fifo level (R) */

/*
 * 16950 register #5.  Accessible if !LCR_EFR_ENABLE.  Read access also
 * requires ACR[6].
 */
#define com_icr         5       /* index control register (R/W) */

/*
 * 16950 register #7.  It is the same as com_scr except it has a different
 * abbreviation in the manufacturer's data sheet and it also serves as an
 * index into the Indexed Control register set.
 */
#define com_spr         com_scr /* scratch pad (and index) register (R/W) */
#define REG_SPR         com_scr

/*
 * 16950 indexed control registers #[0-0x13].  Access is via index in SPR,
 * data in ICR (if ICR is accessible).
 */

#define com_acr         0       /* additional control register (R/W) */
#define ACR_ASE         0x80    /* ASR/RFL/TFL enable */
#define ACR_ICRE        0x40    /* ICR enable */
#define ACR_TLE         0x20    /* TTL/RTL enable */

#define com_cpr         1       /* clock prescaler register (R/W) */
#define com_tcr         2       /* times clock register (R/W) */
#define com_ttl         4       /* transmitter trigger level (R/W) */
#define com_rtl         5       /* receiver trigger level (R/W) */
/* ... */

/* Hardware extension mode register for RSB-2000/3000. */
#define com_emr         com_msr
#define EMR_EXBUFF      0x04
#define EMR_CTSFLW      0x08
#define EMR_DSRFLW      0x10
#define EMR_RTSFLW      0x20
#define EMR_DTRFLW      0x40
#define EMR_EFMODE      0x80