root/arch/m68k/include/asm/mcfuart.h
/* SPDX-License-Identifier: GPL-2.0 */
/****************************************************************************/

/*
 *      mcfuart.h -- ColdFire internal UART support defines.
 *
 *      (C) Copyright 1999-2003, Greg Ungerer (gerg@snapgear.com)
 *      (C) Copyright 2000, Lineo Inc. (www.lineo.com) 
 */

/****************************************************************************/
#ifndef mcfuart_h
#define mcfuart_h
/****************************************************************************/

#include <linux/serial_core.h>
#include <linux/platform_device.h>

struct mcf_platform_uart {
        unsigned long   mapbase;        /* Physical address base */
        void __iomem    *membase;       /* Virtual address if mapped */
        unsigned int    irq;            /* Interrupt vector */
        unsigned int    uartclk;        /* UART clock rate */
};

/*
 *      Define the ColdFire UART register set addresses.
 */
#define MCFUART_UMR             0x00            /* Mode register (r/w) */
#define MCFUART_USR             0x04            /* Status register (r) */
#define MCFUART_UCSR            0x04            /* Clock Select (w) */
#define MCFUART_UCR             0x08            /* Command register (w) */
#define MCFUART_URB             0x0c            /* Receiver Buffer (r) */
#define MCFUART_UTB             0x0c            /* Transmit Buffer (w) */
#define MCFUART_UIPCR           0x10            /* Input Port Change (r) */
#define MCFUART_UACR            0x10            /* Auxiliary Control (w) */
#define MCFUART_UISR            0x14            /* Interrupt Status (r) */
#define MCFUART_UIMR            0x14            /* Interrupt Mask (w) */
#define MCFUART_UBG1            0x18            /* Baud Rate MSB (r/w) */
#define MCFUART_UBG2            0x1c            /* Baud Rate LSB (r/w) */
#ifdef  CONFIG_M5272
#define MCFUART_UTF             0x28            /* Transmitter FIFO (r/w) */
#define MCFUART_URF             0x2c            /* Receiver FIFO (r/w) */
#define MCFUART_UFPD            0x30            /* Frac Prec. Divider (r/w) */
#endif
#if defined(CONFIG_M5206) || defined(CONFIG_M5206e) || \
        defined(CONFIG_M5249) || defined(CONFIG_M525x) || \
        defined(CONFIG_M5307) || defined(CONFIG_M5407)
#define MCFUART_UIVR            0x30            /* Interrupt Vector (r/w) */
#endif
#define MCFUART_UIPR            0x34            /* Input Port (r) */
#define MCFUART_UOP1            0x38            /* Output Port Bit Set (w) */
#define MCFUART_UOP0            0x3c            /* Output Port Bit Reset (w) */


/*
 *      Define bit flags in Mode Register 1 (MR1).
 */
#define MCFUART_MR1_RXRTS       0x80            /* Auto RTS flow control */
#define MCFUART_MR1_RXIRQFULL   0x40            /* RX IRQ type FULL */
#define MCFUART_MR1_RXIRQRDY    0x00            /* RX IRQ type RDY */
#define MCFUART_MR1_RXERRBLOCK  0x20            /* RX block error mode */
#define MCFUART_MR1_RXERRCHAR   0x00            /* RX char error mode */

#define MCFUART_MR1_PARITYNONE  0x10            /* No parity */
#define MCFUART_MR1_PARITYEVEN  0x00            /* Even parity */
#define MCFUART_MR1_PARITYODD   0x04            /* Odd parity */
#define MCFUART_MR1_PARITYSPACE 0x08            /* Space parity */
#define MCFUART_MR1_PARITYMARK  0x0c            /* Mark parity */

#define MCFUART_MR1_CS5         0x00            /* 5 bits per char */
#define MCFUART_MR1_CS6         0x01            /* 6 bits per char */
#define MCFUART_MR1_CS7         0x02            /* 7 bits per char */
#define MCFUART_MR1_CS8         0x03            /* 8 bits per char */

/*
 *      Define bit flags in Mode Register 2 (MR2).
 */
#define MCFUART_MR2_LOOPBACK    0x80            /* Loopback mode */
#define MCFUART_MR2_REMOTELOOP  0xc0            /* Remote loopback mode */
#define MCFUART_MR2_AUTOECHO    0x40            /* Automatic echo */
#define MCFUART_MR2_TXRTS       0x20            /* Assert RTS on TX */
#define MCFUART_MR2_TXCTS       0x10            /* Auto CTS flow control */

#define MCFUART_MR2_STOP1       0x07            /* 1 stop bit */
#define MCFUART_MR2_STOP15      0x08            /* 1.5 stop bits */
#define MCFUART_MR2_STOP2       0x0f            /* 2 stop bits */

/*
 *      Define bit flags in Status Register (USR).
 */
#define MCFUART_USR_RXBREAK     0x80            /* Received BREAK */
#define MCFUART_USR_RXFRAMING   0x40            /* Received framing error */
#define MCFUART_USR_RXPARITY    0x20            /* Received parity error */
#define MCFUART_USR_RXOVERRUN   0x10            /* Received overrun error */
#define MCFUART_USR_TXEMPTY     0x08            /* Transmitter empty */
#define MCFUART_USR_TXREADY     0x04            /* Transmitter ready */
#define MCFUART_USR_RXFULL      0x02            /* Receiver full */
#define MCFUART_USR_RXREADY     0x01            /* Receiver ready */

#define MCFUART_USR_RXERR       (MCFUART_USR_RXBREAK | MCFUART_USR_RXFRAMING | \
                                MCFUART_USR_RXPARITY | MCFUART_USR_RXOVERRUN)

/*
 *      Define bit flags in Clock Select Register (UCSR).
 */
#define MCFUART_UCSR_RXCLKTIMER 0xd0            /* RX clock is timer */
#define MCFUART_UCSR_RXCLKEXT16 0xe0            /* RX clock is external x16 */
#define MCFUART_UCSR_RXCLKEXT1  0xf0            /* RX clock is external x1 */

#define MCFUART_UCSR_TXCLKTIMER 0x0d            /* TX clock is timer */
#define MCFUART_UCSR_TXCLKEXT16 0x0e            /* TX clock is external x16 */
#define MCFUART_UCSR_TXCLKEXT1  0x0f            /* TX clock is external x1 */

/*
 *      Define bit flags in Command Register (UCR).
 */
#define MCFUART_UCR_CMDNULL             0x00    /* No command */
#define MCFUART_UCR_CMDRESETMRPTR       0x10    /* Reset MR pointer */
#define MCFUART_UCR_CMDRESETRX          0x20    /* Reset receiver */
#define MCFUART_UCR_CMDRESETTX          0x30    /* Reset transmitter */
#define MCFUART_UCR_CMDRESETERR         0x40    /* Reset error status */
#define MCFUART_UCR_CMDRESETBREAK       0x50    /* Reset BREAK change */
#define MCFUART_UCR_CMDBREAKSTART       0x60    /* Start BREAK */
#define MCFUART_UCR_CMDBREAKSTOP        0x70    /* Stop BREAK */

#define MCFUART_UCR_TXNULL      0x00            /* No TX command */
#define MCFUART_UCR_TXENABLE    0x04            /* Enable TX */
#define MCFUART_UCR_TXDISABLE   0x08            /* Disable TX */
#define MCFUART_UCR_RXNULL      0x00            /* No RX command */
#define MCFUART_UCR_RXENABLE    0x01            /* Enable RX */
#define MCFUART_UCR_RXDISABLE   0x02            /* Disable RX */

/*
 *      Define bit flags in Input Port Change Register (UIPCR).
 */
#define MCFUART_UIPCR_CTSCOS    0x10            /* CTS change of state */
#define MCFUART_UIPCR_CTS       0x01            /* CTS value */

/*
 *      Define bit flags in Input Port Register (UIP).
 */
#define MCFUART_UIPR_CTS        0x01            /* CTS value */

/*
 *      Define bit flags in Output Port Registers (UOP).
 *      Clear bit by writing to UOP0, set by writing to UOP1.
 */
#define MCFUART_UOP_RTS         0x01            /* RTS set or clear */

/*
 *      Define bit flags in the Auxiliary Control Register (UACR).
 */
#define MCFUART_UACR_IEC        0x01            /* Input enable control */

/*
 *      Define bit flags in Interrupt Status Register (UISR).
 *      These same bits are used for the Interrupt Mask Register (UIMR).
 */
#define MCFUART_UIR_COS         0x80            /* Change of state (CTS) */
#define MCFUART_UIR_DELTABREAK  0x04            /* Break start or stop */
#define MCFUART_UIR_RXREADY     0x02            /* Receiver ready */
#define MCFUART_UIR_TXREADY     0x01            /* Transmitter ready */

#ifdef  CONFIG_M5272
/*
 *      Define bit flags in the Transmitter FIFO Register (UTF).
 */
#define MCFUART_UTF_TXB         0x1f            /* Transmitter data level */
#define MCFUART_UTF_FULL        0x20            /* Transmitter fifo full */
#define MCFUART_UTF_TXS         0xc0            /* Transmitter status */

/*
 *      Define bit flags in the Receiver FIFO Register (URF).
 */
#define MCFUART_URF_RXB         0x1f            /* Receiver data level */
#define MCFUART_URF_FULL        0x20            /* Receiver fifo full */
#define MCFUART_URF_RXS         0xc0            /* Receiver status */
#endif

#if defined(CONFIG_M54xx)
#define MCFUART_TXFIFOSIZE      512
#elif defined(CONFIG_M5272)
#define MCFUART_TXFIFOSIZE      25
#else
#define MCFUART_TXFIFOSIZE      1
#endif
/****************************************************************************/
#endif  /* mcfuart_h */