Merge branch 'master' of git://git.denx.de/u-boot
[platform/kernel/u-boot.git] / drivers / serial / serial_sh.c
index 46600e6..3641c9f 100644 (file)
 /*
  * SuperH SCIF device driver.
- * Copyright (c) 2007,2008 Nobuhiro Iwamatsu
+ * Copyright (C) 2013  Renesas Electronics Corporation
+ * Copyright (C) 2007,2008,2010, 2014 Nobuhiro Iwamatsu
+ * Copyright (C) 2002 - 2008  Paul Mundt
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * SPDX-License-Identifier:    GPL-2.0+
  */
 
 #include <common.h>
+#include <errno.h>
+#include <dm.h>
+#include <asm/io.h>
 #include <asm/processor.h>
+#include <serial.h>
+#include <linux/compiler.h>
+#include <dm/platform_data/serial_sh.h>
+#include "serial_sh.h"
 
-#if defined (CONFIG_CONS_SCIF0)
-#define SCIF_BASE      SCIF0_BASE
-#elif defined (CONFIG_CONS_SCIF1)
-#define SCIF_BASE      SCIF1_BASE
-#elif defined (CONFIG_CONS_SCIF2)
-#define SCIF_BASE      SCIF2_BASE
+#if defined(CONFIG_CPU_SH7760) || \
+       defined(CONFIG_CPU_SH7780) || \
+       defined(CONFIG_CPU_SH7785) || \
+       defined(CONFIG_CPU_SH7786)
+static int scif_rxfill(struct uart_port *port)
+{
+       return sci_in(port, SCRFDR) & 0xff;
+}
+#elif defined(CONFIG_CPU_SH7763)
+static int scif_rxfill(struct uart_port *port)
+{
+       if ((port->mapbase == 0xffe00000) ||
+           (port->mapbase == 0xffe08000)) {
+               /* SCIF0/1*/
+               return sci_in(port, SCRFDR) & 0xff;
+       } else {
+               /* SCIF2 */
+               return sci_in(port, SCFDR) & SCIF2_RFDC_MASK;
+       }
+}
+#elif defined(CONFIG_ARCH_SH7372)
+static int scif_rxfill(struct uart_port *port)
+{
+       if (port->type == PORT_SCIFA)
+               return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
+       else
+               return sci_in(port, SCRFDR);
+}
 #else
-#error "Default SCIF doesn't set....."
+static int scif_rxfill(struct uart_port *port)
+{
+       return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
+}
 #endif
 
-/* Base register */
-#define SCSMR  (vu_short *)(SCIF_BASE + 0x0)
-#define SCBRR  (vu_char  *)(SCIF_BASE + 0x4)
-#define SCSCR  (vu_short *)(SCIF_BASE + 0x8)
-#define SCFCR  (vu_short *)(SCIF_BASE + 0x18)
-#define SCFDR  (vu_short *)(SCIF_BASE + 0x1C)
-#ifdef CONFIG_CPU_SH7720       /* SH7720 specific */
-# define SCFSR (vu_short *)(SCIF_BASE + 0x14)  /* SCSSR */
-# define SCFTDR        (vu_char  *)(SCIF_BASE + 0x20)
-# define SCFRDR        (vu_char  *)(SCIF_BASE + 0x24)
-#else
-# define SCFTDR (vu_char  *)(SCIF_BASE + 0xC)
-# define SCFSR         (vu_short *)(SCIF_BASE + 0x10)
-# define SCFRDR (vu_char  *)(SCIF_BASE + 0x14)
-#endif
+static void sh_serial_init_generic(struct uart_port *port)
+{
+       sci_out(port, SCSCR , SCSCR_INIT(port));
+       sci_out(port, SCSCR , SCSCR_INIT(port));
+       sci_out(port, SCSMR, 0);
+       sci_out(port, SCSMR, 0);
+       sci_out(port, SCFCR, SCFCR_RFRST|SCFCR_TFRST);
+       sci_in(port, SCFCR);
+       sci_out(port, SCFCR, 0);
+}
 
-#if    defined(CONFIG_CPU_SH7780) || \
-       defined(CONFIG_CPU_SH7785)
-# define SCRFDR        (vu_short *)(SCIF_BASE + 0x20)
-# define SCSPTR        (vu_short *)(SCIF_BASE + 0x24)
-# define SCLSR (vu_short *)(SCIF_BASE + 0x28)
-# define SCRER (vu_short *)(SCIF_BASE + 0x2C)
-# define LSR_ORER      1
-# define FIFOLEVEL_MASK        0xFF
-#elif defined(CONFIG_CPU_SH7763)
-# if defined (CONFIG_CONS_SCIF2)
-# define SCSPTR        (vu_short *)(SCIF_BASE + 0x20)
-# define SCLSR         (vu_short *)(SCIF_BASE + 0x24)
-# define LSR_ORER      1
-# define FIFOLEVEL_MASK        0x1F
-# else
-# define SCRFDR        (vu_short *)(SCIF_BASE + 0x20)
-# define SCSPTR        (vu_short *)(SCIF_BASE + 0x24)
-# define SCLSR (vu_short *)(SCIF_BASE + 0x28)
-# define SCRER (vu_short *)(SCIF_BASE + 0x2C)
-# define LSR_ORER      1
-# define FIFOLEVEL_MASK        0xFF
-# endif
-#elif defined(CONFIG_CPU_SH7750) || \
-       defined(CONFIG_CPU_SH7751) || \
-       defined(CONFIG_CPU_SH7722) || \
-       defined(CONFIG_CPU_SH7203)
-# define SCSPTR        (vu_short *)(SCIF_BASE + 0x20)
-# define SCLSR         (vu_short *)(SCIF_BASE + 0x24)
-# define LSR_ORER      1
-# define FIFOLEVEL_MASK        0x1F
-#elif defined(CONFIG_CPU_SH7720)
-# define SCLSR         (vu_short *)(SCIF_BASE + 0x24)
-# define LSR_ORER      0x0200
-# define FIFOLEVEL_MASK        0x1F
-#elif defined(CONFIG_CPU_SH7710) || \
-       defined(CONFIG_CPU_SH7712)
-# define SCLSR SCFSR           /* SCSSR */
-# define LSR_ORER      1
-# define FIFOLEVEL_MASK        0x1F
-#endif
+static void
+sh_serial_setbrg_generic(struct uart_port *port, int clk, int baudrate)
+{
+       if (port->clk_mode == EXT_CLK) {
+               unsigned short dl = DL_VALUE(baudrate, clk);
+               sci_out(port, DL, dl);
+               /* Need wait: Clock * 1/dl \e$B!_\e(B 1/16 */
+               udelay((1000000 * dl * 16 / clk) * 1000 + 1);
+       } else {
+               sci_out(port, SCBRR, SCBRR_VALUE(baudrate, clk));
+       }
+}
 
-/* SCBRR register value setting */
-#if defined(CONFIG_CPU_SH7720)
-# define SCBRR_VALUE(bps, clk) (((clk*2)+16*bps)/(32*bps)-1)
-#else /* Generic SuperH */
-# define SCBRR_VALUE(bps, clk) ((clk+16*bps)/(32*bps)-1)
-#endif
+static void handle_error(struct uart_port *port)
+{
+       sci_in(port, SCxSR);
+       sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
+       sci_in(port, SCLSR);
+       sci_out(port, SCLSR, 0x00);
+}
 
-#define SCR_RE                 (1 << 4)
-#define SCR_TE                 (1 << 5)
-#define FCR_RFRST      (1 << 1)        /* RFCL */
-#define FCR_TFRST      (1 << 2)        /* TFCL */
-#define FSR_DR         (1 << 0)
-#define FSR_RDF        (1 << 1)
-#define FSR_FER        (1 << 3)
-#define FSR_BRK        (1 << 4)
-#define FSR_FER        (1 << 3)
-#define FSR_TEND       (1 << 6)
-#define FSR_ER         (1 << 7)
+static int serial_raw_putc(struct uart_port *port, const char c)
+{
+       /* Tx fifo is empty */
+       if (!(sci_in(port, SCxSR) & SCxSR_TEND(port)))
+               return -EAGAIN;
 
-/*----------------------------------------------------------------------*/
+       sci_out(port, SCxTDR, c);
+       sci_out(port, SCxSR, sci_in(port, SCxSR) & ~SCxSR_TEND(port));
 
-void serial_setbrg(void)
+       return 0;
+}
+
+static int serial_rx_fifo_level(struct uart_port *port)
 {
-       DECLARE_GLOBAL_DATA_PTR;
-       *SCBRR = SCBRR_VALUE(gd->baudrate, CONFIG_SYS_CLK_FREQ);
+       return scif_rxfill(port);
 }
 
-int serial_init(void)
+static int sh_serial_tstc_generic(struct uart_port *port)
 {
-       *SCSCR = (SCR_RE | SCR_TE);
-       *SCSMR = 0;
-       *SCSMR = 0;
-       *SCFCR = (FCR_RFRST | FCR_TFRST);
-       *SCFCR;
-       *SCFCR = 0;
+       if (sci_in(port, SCxSR) & SCIF_ERRORS) {
+               handle_error(port);
+               return 0;
+       }
 
-       serial_setbrg();
-       return 0;
+       return serial_rx_fifo_level(port) ? 1 : 0;
 }
 
-static int serial_rx_fifo_level(void)
+static int serial_getc_check(struct uart_port *port)
 {
-#if defined(SCRFDR)
-       return (*SCRFDR >> 0) & FIFOLEVEL_MASK;
-#else
-       return (*SCFDR >> 0) & FIFOLEVEL_MASK;
-#endif
+       unsigned short status;
+
+       status = sci_in(port, SCxSR);
+
+       if (status & SCIF_ERRORS)
+               handle_error(port);
+       if (sci_in(port, SCLSR) & SCxSR_ORER(port))
+               handle_error(port);
+       return status & (SCIF_DR | SCxSR_RDxF(port));
 }
 
-void serial_raw_putc(const char c)
+static int sh_serial_getc_generic(struct uart_port *port)
 {
-       unsigned int fsr_bits_to_clear;
+       unsigned short status;
+       char ch;
 
-       while (1) {
-               if (*SCFSR & FSR_TEND) {        /* Tx fifo is empty */
-                       fsr_bits_to_clear = FSR_TEND;
-                       break;
-               }
-       }
+       if (!serial_getc_check(port))
+               return -EAGAIN;
+
+       ch = sci_in(port, SCxRDR);
+       status = sci_in(port, SCxSR);
+
+       sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
+
+       if (status & SCIF_ERRORS)
+               handle_error(port);
+
+       if (sci_in(port, SCLSR) & SCxSR_ORER(port))
+               handle_error(port);
+
+       return ch;
+}
+
+#ifdef CONFIG_DM_SERIAL
 
-       *SCFTDR = c;
-       if (fsr_bits_to_clear != 0)
-               *SCFSR &= ~fsr_bits_to_clear;
+static int sh_serial_pending(struct udevice *dev, bool input)
+{
+       struct uart_port *priv = dev_get_priv(dev);
+
+       return sh_serial_tstc_generic(priv);
 }
 
-void serial_putc(const char c)
+static int sh_serial_putc(struct udevice *dev, const char ch)
 {
-       if (c == '\n')
-               serial_raw_putc('\r');
-       serial_raw_putc(c);
+       struct uart_port *priv = dev_get_priv(dev);
+
+       return serial_raw_putc(priv, ch);
 }
 
-void serial_puts(const char *s)
+static int sh_serial_getc(struct udevice *dev)
 {
-       char c;
-       while ((c = *s++) != 0)
-               serial_putc(c);
+       struct uart_port *priv = dev_get_priv(dev);
+
+       return sh_serial_getc_generic(priv);
 }
 
-int serial_tstc(void)
+static int sh_serial_setbrg(struct udevice *dev, int baudrate)
 {
-       return serial_rx_fifo_level()? 1 : 0;
+       struct sh_serial_platdata *plat = dev_get_platdata(dev);
+       struct uart_port *priv = dev_get_priv(dev);
+
+       sh_serial_setbrg_generic(priv, plat->clk, baudrate);
+
+       return 0;
 }
 
-#define FSR_ERR_CLEAR   0x0063
-#define RDRF_CLEAR      0x00fc
-void handle_error(void)
+static int sh_serial_probe(struct udevice *dev)
 {
+       struct sh_serial_platdata *plat = dev_get_platdata(dev);
+       struct uart_port *priv = dev_get_priv(dev);
 
-       (void)*SCFSR;
-       *SCFSR = FSR_ERR_CLEAR;
-       (void)*SCLSR;
-       *SCLSR = 0x00;
+       priv->membase   = (unsigned char *)plat->base;
+       priv->mapbase   = plat->base;
+       priv->type      = plat->type;
+       priv->clk_mode  = plat->clk_mode;
+
+       sh_serial_init_generic(priv);
+
+       return 0;
 }
 
-int serial_getc_check(void)
+static const struct dm_serial_ops sh_serial_ops = {
+       .putc = sh_serial_putc,
+       .pending = sh_serial_pending,
+       .getc = sh_serial_getc,
+       .setbrg = sh_serial_setbrg,
+};
+
+U_BOOT_DRIVER(serial_sh) = {
+       .name   = "serial_sh",
+       .id     = UCLASS_SERIAL,
+       .probe  = sh_serial_probe,
+       .ops    = &sh_serial_ops,
+       .flags  = DM_FLAG_PRE_RELOC,
+       .priv_auto_alloc_size = sizeof(struct uart_port),
+};
+
+#else /* CONFIG_DM_SERIAL */
+
+#if defined(CONFIG_CONS_SCIF0)
+# define SCIF_BASE     SCIF0_BASE
+#elif defined(CONFIG_CONS_SCIF1)
+# define SCIF_BASE     SCIF1_BASE
+#elif defined(CONFIG_CONS_SCIF2)
+# define SCIF_BASE     SCIF2_BASE
+#elif defined(CONFIG_CONS_SCIF3)
+# define SCIF_BASE     SCIF3_BASE
+#elif defined(CONFIG_CONS_SCIF4)
+# define SCIF_BASE     SCIF4_BASE
+#elif defined(CONFIG_CONS_SCIF5)
+# define SCIF_BASE     SCIF5_BASE
+#elif defined(CONFIG_CONS_SCIF6)
+# define SCIF_BASE     SCIF6_BASE
+#elif defined(CONFIG_CONS_SCIF7)
+# define SCIF_BASE     SCIF7_BASE
+#else
+# error "Default SCIF doesn't set....."
+#endif
+
+#if defined(CONFIG_SCIF_A)
+       #define SCIF_BASE_PORT  PORT_SCIFA
+#else
+       #define SCIF_BASE_PORT  PORT_SCIF
+#endif
+
+static struct uart_port sh_sci = {
+       .membase        = (unsigned char *)SCIF_BASE,
+       .mapbase        = SCIF_BASE,
+       .type           = SCIF_BASE_PORT,
+#ifdef CONFIG_SCIF_USE_EXT_CLK
+       .clk_mode =     EXT_CLK,
+#endif
+};
+
+static void sh_serial_setbrg(void)
 {
-       unsigned short status;
+       DECLARE_GLOBAL_DATA_PTR;
+       struct uart_port *port = &sh_sci;
 
-       status = *SCFSR;
+       sh_serial_setbrg_generic(port, CONFIG_SH_SCIF_CLK_FREQ, gd->baudrate);
+}
+
+static int sh_serial_init(void)
+{
+       struct uart_port *port = &sh_sci;
 
-       if (status & (FSR_FER | FSR_ER | FSR_BRK))
-               handle_error();
-       if (*SCLSR & LSR_ORER)
-               handle_error();
-       return (status & (FSR_DR | FSR_RDF));
+       sh_serial_init_generic(port);
+       serial_setbrg();
+
+       return 0;
 }
 
-int serial_getc(void)
+static void sh_serial_putc(const char c)
 {
-       unsigned short status;
-       char ch;
-       while (!serial_getc_check()) ;
+       struct uart_port *port = &sh_sci;
 
-       ch = *SCFRDR;
-       status = *SCFSR;
+       if (c == '\n') {
+               while (1) {
+                       if  (serial_raw_putc(port, '\r') != -EAGAIN)
+                               break;
+               }
+       }
+       while (1) {
+               if  (serial_raw_putc(port, c) != -EAGAIN)
+                       break;
+       }
+}
 
-       *SCFSR = RDRF_CLEAR;
+static int sh_serial_tstc(void)
+{
+       struct uart_port *port = &sh_sci;
 
-       if (status & (FSR_FER | FSR_FER | FSR_ER | FSR_BRK))
-               handle_error();
+       return sh_serial_tstc_generic(port);
+}
 
-       if (*SCLSR & LSR_ORER)
-               handle_error();
+static int sh_serial_getc(void)
+{
+       struct uart_port *port = &sh_sci;
+       int ch;
+
+       while (1) {
+               ch = sh_serial_getc_generic(port);
+               if (ch != -EAGAIN)
+                       break;
+       }
 
        return ch;
 }
+
+static struct serial_device sh_serial_drv = {
+       .name   = "sh_serial",
+       .start  = sh_serial_init,
+       .stop   = NULL,
+       .setbrg = sh_serial_setbrg,
+       .putc   = sh_serial_putc,
+       .puts   = default_serial_puts,
+       .getc   = sh_serial_getc,
+       .tstc   = sh_serial_tstc,
+};
+
+void sh_serial_initialize(void)
+{
+       serial_register(&sh_serial_drv);
+}
+
+__weak struct serial_device *default_serial_console(void)
+{
+       return &sh_serial_drv;
+}
+#endif /* CONFIG_DM_SERIAL */