drivers/tty/serial/8250/8250_of.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  *  Serial Port driver for Open Firmware platform devices
   4  *
   5  *    Copyright (C) 2006 Arnd Bergmann <arnd@arndb.de>, IBM Corp.
   6  */
   7 #include <linux/console.h>
   8 #include <linux/module.h>
   9 #include <linux/slab.h>
  10 #include <linux/delay.h>
  11 #include <linux/serial_core.h>
  12 #include <linux/serial_reg.h>
  13 #include <linux/of_address.h>
  14 #include <linux/of_irq.h>
  15 #include <linux/of_platform.h>
  16 #include <linux/pm_runtime.h>
  17 #include <linux/clk.h>
  18 #include <linux/reset.h>
  19
  20 #include "8250.h"
  21
  22 struct of_serial_info {
  23         struct clk *clk;
  24         struct reset_control *rst;
  25         int type;
  26         int line;
  27 };
  28
  29 #ifdef CONFIG_ARCH_TEGRA
  30 static void tegra_serial_handle_break(struct uart_port *p)
  31 {
  32         unsigned int status, tmout = 10000;
  33
  34         do {
  35                 status = p->serial_in(p, UART_LSR);
  36                 if (status & (UART_LSR_FIFOE | UART_LSR_BRK_ERROR_BITS))
  37                         status = p->serial_in(p, UART_RX);
  38                 else
  39                         break;
  40                 if (--tmout == 0)
  41                         break;
  42                 udelay(1);
  43         } while (1);
  44 }
  45 #else
  46 static inline void tegra_serial_handle_break(struct uart_port *port)
  47 {
  48 }
  49 #endif
  50
  51 /*
  52  * Fill a struct uart_port for a given device node
  53  */
  54 static int of_platform_serial_setup(struct platform_device *ofdev,
  55                         int type, struct uart_port *port,
  56                         struct of_serial_info *info)
  57 {
  58         struct resource resource;
  59         struct device_node *np = ofdev->dev.of_node;
  60         u32 clk, spd, prop;
  61         int ret;
  62
  63         memset(port, 0, sizeof *port);
  64
  65         pm_runtime_enable(&ofdev->dev);
  66         pm_runtime_get_sync(&ofdev->dev);
  67
  68         if (of_property_read_u32(np, "clock-frequency", &clk)) {
  69
  70                 /* Get clk rate through clk driver if present */
  71                 info->clk = devm_clk_get(&ofdev->dev, NULL);
  72                 if (IS_ERR(info->clk)) {
  73                         dev_warn(&ofdev->dev,
  74                                 "clk or clock-frequency not defined\n");
  75                         ret = PTR_ERR(info->clk);
  76                         goto err_pmruntime;
  77                 }
  78
  79                 ret = clk_prepare_enable(info->clk);
  80                 if (ret < 0)
  81                         goto err_pmruntime;
  82
  83                 clk = clk_get_rate(info->clk);
  84         }
  85         /* If current-speed was set, then try not to change it. */
  86         if (of_property_read_u32(np, "current-speed", &spd) == 0)
  87                 port->custom_divisor = clk / (16 * spd);
  88
  89         ret = of_address_to_resource(np, 0, &resource);
  90         if (ret) {
  91                 dev_warn(&ofdev->dev, "invalid address\n");
  92                 goto err_unprepare;
  93         }
  94
  95         spin_lock_init(&port->lock);
  96         port->mapbase = resource.start;
  97         port->mapsize = resource_size(&resource);
  98
  99         /* Check for shifted address mapping */
 100         if (of_property_read_u32(np, "reg-offset", &prop) == 0)
 101                 port->mapbase += prop;
 102
 103         /* Compatibility with the deprecated pxa driver and 8250_pxa drivers. */
 104         if (of_device_is_compatible(np, "mrvl,mmp-uart"))
 105                 port->regshift = 2;
 106
 107         /* Check for registers offset within the devices address range */
 108         if (of_property_read_u32(np, "reg-shift", &prop) == 0)
 109                 port->regshift = prop;
 110
 111         /* Check for fifo size */
 112         if (of_property_read_u32(np, "fifo-size", &prop) == 0)
 113                 port->fifosize = prop;
 114
 115         /* Check for a fixed line number */
 116         ret = of_alias_get_id(np, "serial");
 117         if (ret >= 0)
 118                 port->line = ret;
 119
 120         port->irq = irq_of_parse_and_map(np, 0);
 121         port->iotype = UPIO_MEM;
 122         if (of_property_read_u32(np, "reg-io-width", &prop) == 0) {
 123                 switch (prop) {
 124                 case 1:
 125                         port->iotype = UPIO_MEM;
 126                         break;
 127                 case 2:
 128                         port->iotype = UPIO_MEM16;
 129                         break;
 130                 case 4:
 131                         port->iotype = of_device_is_big_endian(np) ?
 132                                        UPIO_MEM32BE : UPIO_MEM32;
 133                         break;
 134                 default:
 135                         dev_warn(&ofdev->dev, "unsupported reg-io-width (%d)\n",
 136                                  prop);
 137                         ret = -EINVAL;
 138                         goto err_dispose;
 139                 }
 140         }
 141
 142         info->rst = devm_reset_control_get_optional_shared(&ofdev->dev, NULL);
 143         if (IS_ERR(info->rst)) {
 144                 ret = PTR_ERR(info->rst);
 145                 goto err_dispose;
 146         }
 147
 148         ret = reset_control_deassert(info->rst);
 149         if (ret)
 150                 goto err_dispose;
 151
 152         port->type = type;
 153         port->uartclk = clk;
 154         port->flags = UPF_SHARE_IRQ | UPF_BOOT_AUTOCONF | UPF_IOREMAP
 155                 | UPF_FIXED_PORT | UPF_FIXED_TYPE;
 156
 157         if (of_property_read_bool(np, "no-loopback-test"))
 158                 port->flags |= UPF_SKIP_TEST;
 159
 160         port->dev = &ofdev->dev;
 161
 162         switch (type) {
 163         case PORT_TEGRA:
 164                 port->handle_break = tegra_serial_handle_break;
 165                 break;
 166
 167         case PORT_RT2880:
 168                 port->iotype = UPIO_AU;
 169                 break;
 170         }
 171
 172         if (IS_ENABLED(CONFIG_SERIAL_8250_FSL) &&
 173             (of_device_is_compatible(np, "fsl,ns16550") ||
 174              of_device_is_compatible(np, "fsl,16550-FIFO64")))
 175                 port->handle_irq = fsl8250_handle_irq;
 176
 177         return 0;
 178 err_dispose:
 179         irq_dispose_mapping(port->irq);
 180 err_unprepare:
 181         clk_disable_unprepare(info->clk);
 182 err_pmruntime:
 183         pm_runtime_put_sync(&ofdev->dev);
 184         pm_runtime_disable(&ofdev->dev);
 185         return ret;
 186 }
 187
 188 /*
 189  * Try to register a serial port
 190  */
 191 static const struct of_device_id of_platform_serial_table[];
 192 static int of_platform_serial_probe(struct platform_device *ofdev)
 193 {
 194         const struct of_device_id *match;
 195         struct of_serial_info *info;
 196         struct uart_8250_port port8250;
 197         u32 tx_threshold;
 198         int port_type;
 199         int ret;
 200
 201         match = of_match_device(of_platform_serial_table, &ofdev->dev);
 202         if (!match)
 203                 return -EINVAL;
 204
 205         if (of_property_read_bool(ofdev->dev.of_node, "used-by-rtas"))
 206                 return -EBUSY;
 207
 208         info = kzalloc(sizeof(*info), GFP_KERNEL);
 209         if (info == NULL)
 210                 return -ENOMEM;
 211
 212         port_type = (unsigned long)match->data;
 213         memset(&port8250, 0, sizeof(port8250));
 214         ret = of_platform_serial_setup(ofdev, port_type, &port8250.port, info);
 215         if (ret)
 216                 goto err_free;
 217
 218         if (port8250.port.fifosize)
 219                 port8250.capabilities = UART_CAP_FIFO;
 220
 221         /* Check for TX FIFO threshold & set tx_loadsz */
 222         if ((of_property_read_u32(ofdev->dev.of_node, "tx-threshold",
 223                                   &tx_threshold) == 0) &&
 224             (tx_threshold < port8250.port.fifosize))
 225                 port8250.tx_loadsz = port8250.port.fifosize - tx_threshold;
 226
 227         if (of_property_read_bool(ofdev->dev.of_node, "auto-flow-control"))
 228                 port8250.capabilities |= UART_CAP_AFE;
 229
 230         if (of_property_read_u32(ofdev->dev.of_node,
 231                         "overrun-throttle-ms",
 232                         &port8250.overrun_backoff_time_ms) != 0)
 233                 port8250.overrun_backoff_time_ms = 0;
 234
 235         ret = serial8250_register_8250_port(&port8250);
 236         if (ret < 0)
 237                 goto err_dispose;
 238
 239         info->type = port_type;
 240         info->line = ret;
 241         platform_set_drvdata(ofdev, info);
 242         return 0;
 243 err_dispose:
 244         irq_dispose_mapping(port8250.port.irq);
 245         pm_runtime_put_sync(&ofdev->dev);
 246         pm_runtime_disable(&ofdev->dev);
 247         clk_disable_unprepare(info->clk);
 248 err_free:
 249         kfree(info);
 250         return ret;
 251 }
 252
 253 /*
 254  * Release a line
 255  */
 256 static int of_platform_serial_remove(struct platform_device *ofdev)
 257 {
 258         struct of_serial_info *info = platform_get_drvdata(ofdev);
 259
 260         serial8250_unregister_port(info->line);
 261
 262         reset_control_assert(info->rst);
 263         pm_runtime_put_sync(&ofdev->dev);
 264         pm_runtime_disable(&ofdev->dev);
 265         clk_disable_unprepare(info->clk);
 266         kfree(info);
 267         return 0;
 268 }
 269
 270 #ifdef CONFIG_PM_SLEEP
 271 static int of_serial_suspend(struct device *dev)
 272 {
 273         struct of_serial_info *info = dev_get_drvdata(dev);
 274         struct uart_8250_port *port8250 = serial8250_get_port(info->line);
 275         struct uart_port *port = &port8250->port;
 276
 277         serial8250_suspend_port(info->line);
 278
 279         if (!uart_console(port) || console_suspend_enabled) {
 280                 pm_runtime_put_sync(dev);
 281                 clk_disable_unprepare(info->clk);
 282         }
 283         return 0;
 284 }
 285
 286 static int of_serial_resume(struct device *dev)
 287 {
 288         struct of_serial_info *info = dev_get_drvdata(dev);
 289         struct uart_8250_port *port8250 = serial8250_get_port(info->line);
 290         struct uart_port *port = &port8250->port;
 291
 292         if (!uart_console(port) || console_suspend_enabled) {
 293                 pm_runtime_get_sync(dev);
 294                 clk_prepare_enable(info->clk);
 295         }
 296
 297         serial8250_resume_port(info->line);
 298
 299         return 0;
 300 }
 301 #endif
 302 static SIMPLE_DEV_PM_OPS(of_serial_pm_ops, of_serial_suspend, of_serial_resume);
 303
 304 /*
 305  * A few common types, add more as needed.
 306  */
 307 static const struct of_device_id of_platform_serial_table[] = {
 308         { .compatible = "ns8250",   .data = (void *)PORT_8250, },
 309         { .compatible = "ns16450",  .data = (void *)PORT_16450, },
 310         { .compatible = "ns16550a", .data = (void *)PORT_16550A, },
 311         { .compatible = "ns16550",  .data = (void *)PORT_16550, },
 312         { .compatible = "ns16750",  .data = (void *)PORT_16750, },
 313         { .compatible = "ns16850",  .data = (void *)PORT_16850, },
 314         { .compatible = "nvidia,tegra20-uart", .data = (void *)PORT_TEGRA, },
 315         { .compatible = "nxp,lpc3220-uart", .data = (void *)PORT_LPC3220, },
 316         { .compatible = "ralink,rt2880-uart", .data = (void *)PORT_RT2880, },
 317         { .compatible = "altr,16550-FIFO32",
 318                 .data = (void *)PORT_ALTR_16550_F32, },
 319         { .compatible = "altr,16550-FIFO64",
 320                 .data = (void *)PORT_ALTR_16550_F64, },
 321         { .compatible = "altr,16550-FIFO128",
 322                 .data = (void *)PORT_ALTR_16550_F128, },
 323         { .compatible = "mediatek,mtk-btif",
 324                 .data = (void *)PORT_MTK_BTIF, },
 325         { .compatible = "mrvl,mmp-uart",
 326                 .data = (void *)PORT_XSCALE, },
 327         { .compatible = "ti,da830-uart", .data = (void *)PORT_DA830, },
 328         { .compatible = "nuvoton,npcm750-uart", .data = (void *)PORT_NPCM, },
 329         { /* end of list */ },
 330 };
 331 MODULE_DEVICE_TABLE(of, of_platform_serial_table);
 332
 333 static struct platform_driver of_platform_serial_driver = {
 334         .driver = {
 335                 .name = "of_serial",
 336                 .of_match_table = of_platform_serial_table,
 337                 .pm = &of_serial_pm_ops,
 338         },
 339         .probe = of_platform_serial_probe,
 340         .remove = of_platform_serial_remove,
 341 };
 342
 343 module_platform_driver(of_platform_serial_driver);
 344
 345 MODULE_AUTHOR("Arnd Bergmann <arnd@arndb.de>");
 346 MODULE_LICENSE("GPL");
 347 MODULE_DESCRIPTION("Serial Port driver for Open Firmware platform devices");