drivers/serial/serial_mxc.c

   1 /*
   2  * (c) 2007 Sascha Hauer <s.hauer@pengutronix.de>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software
  16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  17  *
  18  */
  19
  20 #include <common.h>
  21 #include <watchdog.h>
  22 #include <asm/arch/imx-regs.h>
  23 #include <asm/arch/clock.h>
  24 #include <serial.h>
  25 #include <linux/compiler.h>
  26
  27 #define __REG(x)     (*((volatile u32 *)(x)))
  28
  29 #ifndef CONFIG_MXC_UART_BASE
  30 #error "define CONFIG_MXC_UART_BASE to use the MXC UART driver"
  31 #endif
  32
  33 #define UART_PHYS       CONFIG_MXC_UART_BASE
  34
  35 #ifdef CONFIG_SERIAL_MULTI
  36 #warning "MXC driver does not support MULTI serials."
  37 #endif
  38
  39 /* Register definitions */
  40 #define URXD  0x0  /* Receiver Register */
  41 #define UTXD  0x40 /* Transmitter Register */
  42 #define UCR1  0x80 /* Control Register 1 */
  43 #define UCR2  0x84 /* Control Register 2 */
  44 #define UCR3  0x88 /* Control Register 3 */
  45 #define UCR4  0x8c /* Control Register 4 */
  46 #define UFCR  0x90 /* FIFO Control Register */
  47 #define USR1  0x94 /* Status Register 1 */
  48 #define USR2  0x98 /* Status Register 2 */
  49 #define UESC  0x9c /* Escape Character Register */
  50 #define UTIM  0xa0 /* Escape Timer Register */
  51 #define UBIR  0xa4 /* BRM Incremental Register */
  52 #define UBMR  0xa8 /* BRM Modulator Register */
  53 #define UBRC  0xac /* Baud Rate Count Register */
  54 #define UTS   0xb4 /* UART Test Register (mx31) */
  55
  56 /* UART Control Register Bit Fields.*/
  57 #define  URXD_CHARRDY    (1<<15)
  58 #define  URXD_ERR        (1<<14)
  59 #define  URXD_OVRRUN     (1<<13)
  60 #define  URXD_FRMERR     (1<<12)
  61 #define  URXD_BRK        (1<<11)
  62 #define  URXD_PRERR      (1<<10)
  63 #define  URXD_RX_DATA    (0xFF)
  64 #define  UCR1_ADEN       (1<<15) /* Auto dectect interrupt */
  65 #define  UCR1_ADBR       (1<<14) /* Auto detect baud rate */
  66 #define  UCR1_TRDYEN     (1<<13) /* Transmitter ready interrupt enable */
  67 #define  UCR1_IDEN       (1<<12) /* Idle condition interrupt */
  68 #define  UCR1_RRDYEN     (1<<9)  /* Recv ready interrupt enable */
  69 #define  UCR1_RDMAEN     (1<<8)  /* Recv ready DMA enable */
  70 #define  UCR1_IREN       (1<<7)  /* Infrared interface enable */
  71 #define  UCR1_TXMPTYEN   (1<<6)  /* Transimitter empty interrupt enable */
  72 #define  UCR1_RTSDEN     (1<<5)  /* RTS delta interrupt enable */
  73 #define  UCR1_SNDBRK     (1<<4)  /* Send break */
  74 #define  UCR1_TDMAEN     (1<<3)  /* Transmitter ready DMA enable */
  75 #define  UCR1_UARTCLKEN  (1<<2)  /* UART clock enabled */
  76 #define  UCR1_DOZE       (1<<1)  /* Doze */
  77 #define  UCR1_UARTEN     (1<<0)  /* UART enabled */
  78 #define  UCR2_ESCI       (1<<15) /* Escape seq interrupt enable */
  79 #define  UCR2_IRTS       (1<<14) /* Ignore RTS pin */
  80 #define  UCR2_CTSC       (1<<13) /* CTS pin control */
  81 #define  UCR2_CTS        (1<<12) /* Clear to send */
  82 #define  UCR2_ESCEN      (1<<11) /* Escape enable */
  83 #define  UCR2_PREN       (1<<8)  /* Parity enable */
  84 #define  UCR2_PROE       (1<<7)  /* Parity odd/even */
  85 #define  UCR2_STPB       (1<<6)  /* Stop */
  86 #define  UCR2_WS         (1<<5)  /* Word size */
  87 #define  UCR2_RTSEN      (1<<4)  /* Request to send interrupt enable */
  88 #define  UCR2_TXEN       (1<<2)  /* Transmitter enabled */
  89 #define  UCR2_RXEN       (1<<1)  /* Receiver enabled */
  90 #define  UCR2_SRST       (1<<0)  /* SW reset */
  91 #define  UCR3_DTREN      (1<<13) /* DTR interrupt enable */
  92 #define  UCR3_PARERREN   (1<<12) /* Parity enable */
  93 #define  UCR3_FRAERREN   (1<<11) /* Frame error interrupt enable */
  94 #define  UCR3_DSR        (1<<10) /* Data set ready */
  95 #define  UCR3_DCD        (1<<9)  /* Data carrier detect */
  96 #define  UCR3_RI         (1<<8)  /* Ring indicator */
  97 #define  UCR3_TIMEOUTEN  (1<<7)  /* Timeout interrupt enable */
  98 #define  UCR3_RXDSEN     (1<<6)  /* Receive status interrupt enable */
  99 #define  UCR3_AIRINTEN   (1<<5)  /* Async IR wake interrupt enable */
 100 #define  UCR3_AWAKEN     (1<<4)  /* Async wake interrupt enable */
 101 #define  UCR3_REF25      (1<<3)  /* Ref freq 25 MHz */
 102 #define  UCR3_REF30      (1<<2)  /* Ref Freq 30 MHz */
 103 #define  UCR3_INVT       (1<<1)  /* Inverted Infrared transmission */
 104 #define  UCR3_BPEN       (1<<0)  /* Preset registers enable */
 105 #define  UCR4_CTSTL_32   (32<<10) /* CTS trigger level (32 chars) */
 106 #define  UCR4_INVR       (1<<9)  /* Inverted infrared reception */
 107 #define  UCR4_ENIRI      (1<<8)  /* Serial infrared interrupt enable */
 108 #define  UCR4_WKEN       (1<<7)  /* Wake interrupt enable */
 109 #define  UCR4_REF16      (1<<6)  /* Ref freq 16 MHz */
 110 #define  UCR4_IRSC       (1<<5)  /* IR special case */
 111 #define  UCR4_TCEN       (1<<3)  /* Transmit complete interrupt enable */
 112 #define  UCR4_BKEN       (1<<2)  /* Break condition interrupt enable */
 113 #define  UCR4_OREN       (1<<1)  /* Receiver overrun interrupt enable */
 114 #define  UCR4_DREN       (1<<0)  /* Recv data ready interrupt enable */
 115 #define  UFCR_RXTL_SHF   0       /* Receiver trigger level shift */
 116 #define  UFCR_RFDIV      (7<<7)  /* Reference freq divider mask */
 117 #define  UFCR_TXTL_SHF   10      /* Transmitter trigger level shift */
 118 #define  USR1_PARITYERR  (1<<15) /* Parity error interrupt flag */
 119 #define  USR1_RTSS       (1<<14) /* RTS pin status */
 120 #define  USR1_TRDY       (1<<13) /* Transmitter ready interrupt/dma flag */
 121 #define  USR1_RTSD       (1<<12) /* RTS delta */
 122 #define  USR1_ESCF       (1<<11) /* Escape seq interrupt flag */
 123 #define  USR1_FRAMERR    (1<<10) /* Frame error interrupt flag */
 124 #define  USR1_RRDY       (1<<9)  /* Receiver ready interrupt/dma flag */
 125 #define  USR1_TIMEOUT    (1<<7)  /* Receive timeout interrupt status */
 126 #define  USR1_RXDS       (1<<6)  /* Receiver idle interrupt flag */
 127 #define  USR1_AIRINT     (1<<5)  /* Async IR wake interrupt flag */
 128 #define  USR1_AWAKE      (1<<4)  /* Aysnc wake interrupt flag */
 129 #define  USR2_ADET       (1<<15) /* Auto baud rate detect complete */
 130 #define  USR2_TXFE       (1<<14) /* Transmit buffer FIFO empty */
 131 #define  USR2_DTRF       (1<<13) /* DTR edge interrupt flag */
 132 #define  USR2_IDLE       (1<<12) /* Idle condition */
 133 #define  USR2_IRINT      (1<<8)  /* Serial infrared interrupt flag */
 134 #define  USR2_WAKE       (1<<7)  /* Wake */
 135 #define  USR2_RTSF       (1<<4)  /* RTS edge interrupt flag */
 136 #define  USR2_TXDC       (1<<3)  /* Transmitter complete */
 137 #define  USR2_BRCD       (1<<2)  /* Break condition */
 138 #define  USR2_ORE        (1<<1)  /* Overrun error */
 139 #define  USR2_RDR        (1<<0)  /* Recv data ready */
 140 #define  UTS_FRCPERR     (1<<13) /* Force parity error */
 141 #define  UTS_LOOP        (1<<12) /* Loop tx and rx */
 142 #define  UTS_TXEMPTY     (1<<6)  /* TxFIFO empty */
 143 #define  UTS_RXEMPTY     (1<<5)  /* RxFIFO empty */
 144 #define  UTS_TXFULL      (1<<4)  /* TxFIFO full */
 145 #define  UTS_RXFULL      (1<<3)  /* RxFIFO full */
 146 #define  UTS_SOFTRST     (1<<0)  /* Software reset */
 147
 148 DECLARE_GLOBAL_DATA_PTR;
 149
 150 static void mxc_serial_setbrg(void)
 151 {
 152         u32 clk = imx_get_uartclk();
 153
 154         if (!gd->baudrate)
 155                 gd->baudrate = CONFIG_BAUDRATE;
 156
 157         __REG(UART_PHYS + UFCR) = 4 << 7; /* divide input clock by 2 */
 158         __REG(UART_PHYS + UBIR) = 0xf;
 159         __REG(UART_PHYS + UBMR) = clk / (2 * gd->baudrate);
 160
 161 }
 162
 163 static int mxc_serial_getc(void)
 164 {
 165         while (__REG(UART_PHYS + UTS) & UTS_RXEMPTY)
 166                 WATCHDOG_RESET();
 167         return (__REG(UART_PHYS + URXD) & URXD_RX_DATA); /* mask out status from upper word */
 168 }
 169
 170 static void mxc_serial_putc(const char c)
 171 {
 172         __REG(UART_PHYS + UTXD) = c;
 173
 174         /* wait for transmitter to be ready */
 175         while (!(__REG(UART_PHYS + UTS) & UTS_TXEMPTY))
 176                 WATCHDOG_RESET();
 177
 178         /* If \n, also do \r */
 179         if (c == '\n')
 180                 serial_putc ('\r');
 181 }
 182
 183 /*
 184  * Test whether a character is in the RX buffer
 185  */
 186 static int mxc_serial_tstc(void)
 187 {
 188         /* If receive fifo is empty, return false */
 189         if (__REG(UART_PHYS + UTS) & UTS_RXEMPTY)
 190                 return 0;
 191         return 1;
 192 }
 193
 194 static void mxc_serial_puts(const char *s)
 195 {
 196         while (*s) {
 197                 serial_putc (*s++);
 198         }
 199 }
 200
 201 /*
 202  * Initialise the serial port with the given baudrate. The settings
 203  * are always 8 data bits, no parity, 1 stop bit, no start bits.
 204  *
 205  */
 206 static int mxc_serial_init(void)
 207 {
 208         __REG(UART_PHYS + UCR1) = 0x0;
 209         __REG(UART_PHYS + UCR2) = 0x0;
 210
 211         while (!(__REG(UART_PHYS + UCR2) & UCR2_SRST));
 212
 213         __REG(UART_PHYS + UCR3) = 0x0704;
 214         __REG(UART_PHYS + UCR4) = 0x8000;
 215         __REG(UART_PHYS + UESC) = 0x002b;
 216         __REG(UART_PHYS + UTIM) = 0x0;
 217
 218         __REG(UART_PHYS + UTS) = 0x0;
 219
 220         serial_setbrg();
 221
 222         __REG(UART_PHYS + UCR2) = UCR2_WS | UCR2_IRTS | UCR2_RXEN | UCR2_TXEN | UCR2_SRST;
 223
 224         __REG(UART_PHYS + UCR1) = UCR1_UARTEN;
 225
 226         return 0;
 227 }
 228
 229 #ifdef CONFIG_SERIAL_MULTI
 230 static struct serial_device mxc_serial_drv = {
 231         .name   = "mxc_serial",
 232         .start  = mxc_serial_init,
 233         .stop   = NULL,
 234         .setbrg = mxc_serial_setbrg,
 235         .putc   = mxc_serial_putc,
 236         .puts   = mxc_serial_puts,
 237         .getc   = mxc_serial_getc,
 238         .tstc   = mxc_serial_tstc,
 239 };
 240
 241 void mxc_serial_initialize(void)
 242 {
 243         serial_register(&mxc_serial_drv);
 244 }
 245
 246 __weak struct serial_device *default_serial_console(void)
 247 {
 248         return &mxc_serial_drv;
 249 }
 250 #else
 251 int serial_init(void)
 252 {
 253         return mxc_serial_init();
 254 }
 255
 256 void serial_setbrg(void)
 257 {
 258         mxc_serial_setbrg();
 259 }
 260
 261 void serial_putc(const char c)
 262 {
 263         mxc_serial_putc(c);
 264 }
 265
 266 void serial_puts(const char *s)
 267 {
 268         mxc_serial_puts(s);
 269 }
 270
 271 int serial_getc(void)
 272 {
 273         return mxc_serial_getc();
 274 }
 275
 276 int serial_tstc(void)
 277 {
 278         return mxc_serial_tstc();
 279 }
 280 #endif