drivers/serial/serial_sh.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * SuperH SCIF device driver.
   4  * Copyright (C) 2013  Renesas Electronics Corporation
   5  * Copyright (C) 2007,2008,2010, 2014 Nobuhiro Iwamatsu
   6  * Copyright (C) 2002 - 2008  Paul Mundt
   7  */
   8
   9 #include <common.h>
  10 #include <errno.h>
  11 #include <clk.h>
  12 #include <dm.h>
  13 #include <asm/io.h>
  14 #include <asm/processor.h>
  15 #include <serial.h>
  16 #include <linux/compiler.h>
  17 #include <dm/platform_data/serial_sh.h>
  18 #include <linux/delay.h>
  19 #include "serial_sh.h"
  20
  21 DECLARE_GLOBAL_DATA_PTR;
  22
  23 #if defined(CONFIG_CPU_SH7780)
  24 static int scif_rxfill(struct uart_port *port)
  25 {
  26         return sci_in(port, SCRFDR) & 0xff;
  27 }
  28 #elif defined(CONFIG_CPU_SH7763)
  29 static int scif_rxfill(struct uart_port *port)
  30 {
  31         if ((port->mapbase == 0xffe00000) ||
  32             (port->mapbase == 0xffe08000)) {
  33                 /* SCIF0/1*/
  34                 return sci_in(port, SCRFDR) & 0xff;
  35         } else {
  36                 /* SCIF2 */
  37                 return sci_in(port, SCFDR) & SCIF2_RFDC_MASK;
  38         }
  39 }
  40 #else
  41 static int scif_rxfill(struct uart_port *port)
  42 {
  43         return sci_in(port, SCFDR) & SCIF_RFDC_MASK;
  44 }
  45 #endif
  46
  47 static void sh_serial_init_generic(struct uart_port *port)
  48 {
  49         sci_out(port, SCSCR , SCSCR_INIT(port));
  50         sci_out(port, SCSCR , SCSCR_INIT(port));
  51         sci_out(port, SCSMR, 0);
  52         sci_out(port, SCSMR, 0);
  53         sci_out(port, SCFCR, SCFCR_RFRST|SCFCR_TFRST);
  54         sci_in(port, SCFCR);
  55         sci_out(port, SCFCR, 0);
  56 #if defined(CONFIG_RZA1)
  57         sci_out(port, SCSPTR, 0x0003);
  58 #endif
  59 }
  60
  61 static void
  62 sh_serial_setbrg_generic(struct uart_port *port, int clk, int baudrate)
  63 {
  64         if (port->clk_mode == EXT_CLK) {
  65                 unsigned short dl = DL_VALUE(baudrate, clk);
  66                 sci_out(port, DL, dl);
  67                 /* Need wait: Clock * 1/dl * 1/16 */
  68                 udelay((1000000 * dl * 16 / clk) * 1000 + 1);
  69         } else {
  70                 sci_out(port, SCBRR, SCBRR_VALUE(baudrate, clk));
  71         }
  72 }
  73
  74 static void handle_error(struct uart_port *port)
  75 {
  76         sci_in(port, SCxSR);
  77         sci_out(port, SCxSR, SCxSR_ERROR_CLEAR(port));
  78         sci_in(port, SCLSR);
  79         sci_out(port, SCLSR, 0x00);
  80 }
  81
  82 static int serial_raw_putc(struct uart_port *port, const char c)
  83 {
  84         /* Tx fifo is empty */
  85         if (!(sci_in(port, SCxSR) & SCxSR_TEND(port)))
  86                 return -EAGAIN;
  87
  88         sci_out(port, SCxTDR, c);
  89         sci_out(port, SCxSR, sci_in(port, SCxSR) & ~SCxSR_TEND(port));
  90
  91         return 0;
  92 }
  93
  94 static int serial_rx_fifo_level(struct uart_port *port)
  95 {
  96         return scif_rxfill(port);
  97 }
  98
  99 static int sh_serial_tstc_generic(struct uart_port *port)
 100 {
 101         if (sci_in(port, SCxSR) & SCIF_ERRORS) {
 102                 handle_error(port);
 103                 return 0;
 104         }
 105
 106         return serial_rx_fifo_level(port) ? 1 : 0;
 107 }
 108
 109 static int serial_getc_check(struct uart_port *port)
 110 {
 111         unsigned short status;
 112
 113         status = sci_in(port, SCxSR);
 114
 115         if (status & SCIF_ERRORS)
 116                 handle_error(port);
 117         if (sci_in(port, SCLSR) & SCxSR_ORER(port))
 118                 handle_error(port);
 119         status &= (SCIF_DR | SCxSR_RDxF(port));
 120         if (status)
 121                 return status;
 122         return scif_rxfill(port);
 123 }
 124
 125 static int sh_serial_getc_generic(struct uart_port *port)
 126 {
 127         unsigned short status;
 128         char ch;
 129
 130         if (!serial_getc_check(port))
 131                 return -EAGAIN;
 132
 133         ch = sci_in(port, SCxRDR);
 134         status = sci_in(port, SCxSR);
 135
 136         sci_out(port, SCxSR, SCxSR_RDxF_CLEAR(port));
 137
 138         if (status & SCIF_ERRORS)
 139                 handle_error(port);
 140
 141         if (sci_in(port, SCLSR) & SCxSR_ORER(port))
 142                 handle_error(port);
 143
 144         return ch;
 145 }
 146
 147 #if CONFIG_IS_ENABLED(DM_SERIAL)
 148
 149 static int sh_serial_pending(struct udevice *dev, bool input)
 150 {
 151         struct uart_port *priv = dev_get_priv(dev);
 152
 153         return sh_serial_tstc_generic(priv);
 154 }
 155
 156 static int sh_serial_putc(struct udevice *dev, const char ch)
 157 {
 158         struct uart_port *priv = dev_get_priv(dev);
 159
 160         return serial_raw_putc(priv, ch);
 161 }
 162
 163 static int sh_serial_getc(struct udevice *dev)
 164 {
 165         struct uart_port *priv = dev_get_priv(dev);
 166
 167         return sh_serial_getc_generic(priv);
 168 }
 169
 170 static int sh_serial_setbrg(struct udevice *dev, int baudrate)
 171 {
 172         struct sh_serial_platdata *plat = dev_get_platdata(dev);
 173         struct uart_port *priv = dev_get_priv(dev);
 174
 175         sh_serial_setbrg_generic(priv, plat->clk, baudrate);
 176
 177         return 0;
 178 }
 179
 180 static int sh_serial_probe(struct udevice *dev)
 181 {
 182         struct sh_serial_platdata *plat = dev_get_platdata(dev);
 183         struct uart_port *priv = dev_get_priv(dev);
 184
 185         priv->membase   = (unsigned char *)plat->base;
 186         priv->mapbase   = plat->base;
 187         priv->type      = plat->type;
 188         priv->clk_mode  = plat->clk_mode;
 189
 190         sh_serial_init_generic(priv);
 191
 192         return 0;
 193 }
 194
 195 static const struct dm_serial_ops sh_serial_ops = {
 196         .putc = sh_serial_putc,
 197         .pending = sh_serial_pending,
 198         .getc = sh_serial_getc,
 199         .setbrg = sh_serial_setbrg,
 200 };
 201
 202 #if CONFIG_IS_ENABLED(OF_CONTROL)
 203 static const struct udevice_id sh_serial_id[] ={
 204         {.compatible = "renesas,sci", .data = PORT_SCI},
 205         {.compatible = "renesas,scif", .data = PORT_SCIF},
 206         {.compatible = "renesas,scifa", .data = PORT_SCIFA},
 207         {}
 208 };
 209
 210 static int sh_serial_ofdata_to_platdata(struct udevice *dev)
 211 {
 212         struct sh_serial_platdata *plat = dev_get_platdata(dev);
 213         struct clk sh_serial_clk;
 214         fdt_addr_t addr;
 215         int ret;
 216
 217         addr = dev_read_addr(dev);
 218         if (!addr)
 219                 return -EINVAL;
 220
 221         plat->base = addr;
 222
 223         ret = clk_get_by_name(dev, "fck", &sh_serial_clk);
 224         if (!ret) {
 225                 ret = clk_enable(&sh_serial_clk);
 226                 if (!ret)
 227                         plat->clk = clk_get_rate(&sh_serial_clk);
 228         } else {
 229                 plat->clk = fdtdec_get_int(gd->fdt_blob, dev_of_offset(dev),
 230                                            "clock", 1);
 231         }
 232
 233         plat->type = dev_get_driver_data(dev);
 234         return 0;
 235 }
 236 #endif
 237
 238 U_BOOT_DRIVER(serial_sh) = {
 239         .name   = "serial_sh",
 240         .id     = UCLASS_SERIAL,
 241         .of_match = of_match_ptr(sh_serial_id),
 242         .ofdata_to_platdata = of_match_ptr(sh_serial_ofdata_to_platdata),
 243         .platdata_auto_alloc_size = sizeof(struct sh_serial_platdata),
 244         .probe  = sh_serial_probe,
 245         .ops    = &sh_serial_ops,
 246 #if !CONFIG_IS_ENABLED(OF_CONTROL)
 247         .flags  = DM_FLAG_PRE_RELOC,
 248 #endif
 249         .priv_auto_alloc_size = sizeof(struct uart_port),
 250 };
 251
 252 #else /* CONFIG_DM_SERIAL */
 253
 254 #if defined(CONFIG_CONS_SCIF0)
 255 # define SCIF_BASE      SCIF0_BASE
 256 #elif defined(CONFIG_CONS_SCIF1)
 257 # define SCIF_BASE      SCIF1_BASE
 258 #elif defined(CONFIG_CONS_SCIF2)
 259 # define SCIF_BASE      SCIF2_BASE
 260 #elif defined(CONFIG_CONS_SCIF3)
 261 # define SCIF_BASE      SCIF3_BASE
 262 #elif defined(CONFIG_CONS_SCIF4)
 263 # define SCIF_BASE      SCIF4_BASE
 264 #elif defined(CONFIG_CONS_SCIF5)
 265 # define SCIF_BASE      SCIF5_BASE
 266 #elif defined(CONFIG_CONS_SCIF6)
 267 # define SCIF_BASE      SCIF6_BASE
 268 #elif defined(CONFIG_CONS_SCIF7)
 269 # define SCIF_BASE      SCIF7_BASE
 270 #elif defined(CONFIG_CONS_SCIFA0)
 271 # define SCIF_BASE      SCIFA0_BASE
 272 #else
 273 # error "Default SCIF doesn't set....."
 274 #endif
 275
 276 #if defined(CONFIG_SCIF_A)
 277         #define SCIF_BASE_PORT  PORT_SCIFA
 278 #elif defined(CONFIG_SCI)
 279         #define SCIF_BASE_PORT  PORT_SCI
 280 #else
 281         #define SCIF_BASE_PORT  PORT_SCIF
 282 #endif
 283
 284 static struct uart_port sh_sci = {
 285         .membase        = (unsigned char *)SCIF_BASE,
 286         .mapbase        = SCIF_BASE,
 287         .type           = SCIF_BASE_PORT,
 288 #ifdef CONFIG_SCIF_USE_EXT_CLK
 289         .clk_mode =     EXT_CLK,
 290 #endif
 291 };
 292
 293 static void sh_serial_setbrg(void)
 294 {
 295         DECLARE_GLOBAL_DATA_PTR;
 296         struct uart_port *port = &sh_sci;
 297
 298         sh_serial_setbrg_generic(port, CONFIG_SH_SCIF_CLK_FREQ, gd->baudrate);
 299 }
 300
 301 static int sh_serial_init(void)
 302 {
 303         struct uart_port *port = &sh_sci;
 304
 305         sh_serial_init_generic(port);
 306         serial_setbrg();
 307
 308         return 0;
 309 }
 310
 311 static void sh_serial_putc(const char c)
 312 {
 313         struct uart_port *port = &sh_sci;
 314
 315         if (c == '\n') {
 316                 while (1) {
 317                         if  (serial_raw_putc(port, '\r') != -EAGAIN)
 318                                 break;
 319                 }
 320         }
 321         while (1) {
 322                 if  (serial_raw_putc(port, c) != -EAGAIN)
 323                         break;
 324         }
 325 }
 326
 327 static int sh_serial_tstc(void)
 328 {
 329         struct uart_port *port = &sh_sci;
 330
 331         return sh_serial_tstc_generic(port);
 332 }
 333
 334 static int sh_serial_getc(void)
 335 {
 336         struct uart_port *port = &sh_sci;
 337         int ch;
 338
 339         while (1) {
 340                 ch = sh_serial_getc_generic(port);
 341                 if (ch != -EAGAIN)
 342                         break;
 343         }
 344
 345         return ch;
 346 }
 347
 348 static struct serial_device sh_serial_drv = {
 349         .name   = "sh_serial",
 350         .start  = sh_serial_init,
 351         .stop   = NULL,
 352         .setbrg = sh_serial_setbrg,
 353         .putc   = sh_serial_putc,
 354         .puts   = default_serial_puts,
 355         .getc   = sh_serial_getc,
 356         .tstc   = sh_serial_tstc,
 357 };
 358
 359 void sh_serial_initialize(void)
 360 {
 361         serial_register(&sh_serial_drv);
 362 }
 363
 364 __weak struct serial_device *default_serial_console(void)
 365 {
 366         return &sh_serial_drv;
 367 }
 368 #endif /* CONFIG_DM_SERIAL */