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