drivers/tty/serial/8250/8250_dw.c

   1 /*
   2  * Synopsys DesignWare 8250 driver.
   3  *
   4  * Copyright 2011 Picochip, Jamie Iles.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * The Synopsys DesignWare 8250 has an extra feature whereby it detects if the
  12  * LCR is written whilst busy.  If it is, then a busy detect interrupt is
  13  * raised, the LCR needs to be rewritten and the uart status register read.
  14  */
  15 #include <linux/device.h>
  16 #include <linux/init.h>
  17 #include <linux/io.h>
  18 #include <linux/module.h>
  19 #include <linux/serial_8250.h>
  20 #include <linux/serial_core.h>
  21 #include <linux/serial_reg.h>
  22 #include <linux/of.h>
  23 #include <linux/of_irq.h>
  24 #include <linux/of_platform.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/slab.h>
  27
  28 /* Offsets for the DesignWare specific registers */
  29 #define DW_UART_USR     0x1f /* UART Status Register */
  30 #define DW_UART_CPR     0xf4 /* Component Parameter Register */
  31 #define DW_UART_UCV     0xf8 /* UART Component Version */
  32
  33 /* Component Parameter Register bits */
  34 #define DW_UART_CPR_ABP_DATA_WIDTH      (3 << 0)
  35 #define DW_UART_CPR_AFCE_MODE           (1 << 4)
  36 #define DW_UART_CPR_THRE_MODE           (1 << 5)
  37 #define DW_UART_CPR_SIR_MODE            (1 << 6)
  38 #define DW_UART_CPR_SIR_LP_MODE         (1 << 7)
  39 #define DW_UART_CPR_ADDITIONAL_FEATURES (1 << 8)
  40 #define DW_UART_CPR_FIFO_ACCESS         (1 << 9)
  41 #define DW_UART_CPR_FIFO_STAT           (1 << 10)
  42 #define DW_UART_CPR_SHADOW              (1 << 11)
  43 #define DW_UART_CPR_ENCODED_PARMS       (1 << 12)
  44 #define DW_UART_CPR_DMA_EXTRA           (1 << 13)
  45 #define DW_UART_CPR_FIFO_MODE           (0xff << 16)
  46 /* Helper for fifo size calculation */
  47 #define DW_UART_CPR_FIFO_SIZE(a)        (((a >> 16) & 0xff) * 16)
  48
  49
  50 struct dw8250_data {
  51         int     last_lcr;
  52         int     line;
  53 };
  54
  55 static void dw8250_serial_out(struct uart_port *p, int offset, int value)
  56 {
  57         struct dw8250_data *d = p->private_data;
  58
  59         if (offset == UART_LCR)
  60                 d->last_lcr = value;
  61
  62         offset <<= p->regshift;
  63         writeb(value, p->membase + offset);
  64 }
  65
  66 static unsigned int dw8250_serial_in(struct uart_port *p, int offset)
  67 {
  68         offset <<= p->regshift;
  69
  70         return readb(p->membase + offset);
  71 }
  72
  73 static void dw8250_serial_out32(struct uart_port *p, int offset, int value)
  74 {
  75         struct dw8250_data *d = p->private_data;
  76
  77         if (offset == UART_LCR)
  78                 d->last_lcr = value;
  79
  80         offset <<= p->regshift;
  81         writel(value, p->membase + offset);
  82 }
  83
  84 static unsigned int dw8250_serial_in32(struct uart_port *p, int offset)
  85 {
  86         offset <<= p->regshift;
  87
  88         return readl(p->membase + offset);
  89 }
  90
  91 static int dw8250_handle_irq(struct uart_port *p)
  92 {
  93         struct dw8250_data *d = p->private_data;
  94         unsigned int iir = p->serial_in(p, UART_IIR);
  95
  96         if (serial8250_handle_irq(p, iir)) {
  97                 return 1;
  98         } else if ((iir & UART_IIR_BUSY) == UART_IIR_BUSY) {
  99                 /* Clear the USR and write the LCR again. */
 100                 (void)p->serial_in(p, DW_UART_USR);
 101                 p->serial_out(p, d->last_lcr, UART_LCR);
 102
 103                 return 1;
 104         }
 105
 106         return 0;
 107 }
 108
 109 static int dw8250_probe_of(struct uart_port *p)
 110 {
 111         struct device_node      *np = p->dev->of_node;
 112         u32                     val;
 113
 114         if (!of_property_read_u32(np, "reg-io-width", &val)) {
 115                 switch (val) {
 116                 case 1:
 117                         break;
 118                 case 4:
 119                         p->iotype = UPIO_MEM32;
 120                         p->serial_in = dw8250_serial_in32;
 121                         p->serial_out = dw8250_serial_out32;
 122                         break;
 123                 default:
 124                         dev_err(p->dev, "unsupported reg-io-width (%u)\n", val);
 125                         return -EINVAL;
 126                 }
 127         }
 128
 129         if (!of_property_read_u32(np, "reg-shift", &val))
 130                 p->regshift = val;
 131
 132         if (of_property_read_u32(np, "clock-frequency", &val)) {
 133                 dev_err(p->dev, "no clock-frequency property set\n");
 134                 return -EINVAL;
 135         }
 136         p->uartclk = val;
 137
 138         return 0;
 139 }
 140
 141 static void dw8250_setup_port(struct uart_8250_port *up)
 142 {
 143         struct uart_port        *p = &up->port;
 144         u32                     reg = readl(p->membase + DW_UART_UCV);
 145
 146         /*
 147          * If the Component Version Register returns zero, we know that
 148          * ADDITIONAL_FEATURES are not enabled. No need to go any further.
 149          */
 150         if (!reg)
 151                 return;
 152
 153         dev_dbg_ratelimited(p->dev, "Designware UART version %c.%c%c\n",
 154                 (reg >> 24) & 0xff, (reg >> 16) & 0xff, (reg >> 8) & 0xff);
 155
 156         reg = readl(p->membase + DW_UART_CPR);
 157         if (!reg)
 158                 return;
 159
 160         /* Select the type based on fifo */
 161         if (reg & DW_UART_CPR_FIFO_MODE) {
 162                 p->type = PORT_16550A;
 163                 p->flags |= UPF_FIXED_TYPE;
 164                 p->fifosize = DW_UART_CPR_FIFO_SIZE(reg);
 165                 up->tx_loadsz = p->fifosize;
 166         }
 167 }
 168
 169 static int dw8250_probe(struct platform_device *pdev)
 170 {
 171         struct uart_8250_port uart = {};
 172         struct resource *regs = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 173         struct resource *irq = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 174         struct dw8250_data *data;
 175         int err;
 176
 177         if (!regs || !irq) {
 178                 dev_err(&pdev->dev, "no registers/irq defined\n");
 179                 return -EINVAL;
 180         }
 181
 182         spin_lock_init(&uart.port.lock);
 183         uart.port.mapbase = regs->start;
 184         uart.port.irq = irq->start;
 185         uart.port.handle_irq = dw8250_handle_irq;
 186         uart.port.type = PORT_8250;
 187         uart.port.flags = UPF_SHARE_IRQ | UPF_BOOT_AUTOCONF | UPF_FIXED_PORT;
 188         uart.port.dev = &pdev->dev;
 189
 190         uart.port.membase = ioremap(regs->start, resource_size(regs));
 191         if (!uart.port.membase)
 192                 return -ENOMEM;
 193
 194         uart.port.iotype = UPIO_MEM;
 195         uart.port.serial_in = dw8250_serial_in;
 196         uart.port.serial_out = dw8250_serial_out;
 197
 198         if (pdev->dev.of_node) {
 199                 err = dw8250_probe_of(&uart.port);
 200                 if (err)
 201                         return err;
 202         } else {
 203                 return -ENODEV;
 204         }
 205
 206         dw8250_setup_port(&uart);
 207
 208         data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
 209         if (!data)
 210                 return -ENOMEM;
 211
 212         uart.port.private_data = data;
 213
 214         data->line = serial8250_register_8250_port(&uart);
 215         if (data->line < 0)
 216                 return data->line;
 217
 218         platform_set_drvdata(pdev, data);
 219
 220         return 0;
 221 }
 222
 223 static int dw8250_remove(struct platform_device *pdev)
 224 {
 225         struct dw8250_data *data = platform_get_drvdata(pdev);
 226
 227         serial8250_unregister_port(data->line);
 228
 229         return 0;
 230 }
 231
 232 #ifdef CONFIG_PM
 233 static int dw8250_suspend(struct platform_device *pdev, pm_message_t state)
 234 {
 235         struct dw8250_data *data = platform_get_drvdata(pdev);
 236
 237         serial8250_suspend_port(data->line);
 238
 239         return 0;
 240 }
 241
 242 static int dw8250_resume(struct platform_device *pdev)
 243 {
 244         struct dw8250_data *data = platform_get_drvdata(pdev);
 245
 246         serial8250_resume_port(data->line);
 247
 248         return 0;
 249 }
 250 #else
 251 #define dw8250_suspend NULL
 252 #define dw8250_resume NULL
 253 #endif /* CONFIG_PM */
 254
 255 static const struct of_device_id dw8250_of_match[] = {
 256         { .compatible = "snps,dw-apb-uart" },
 257         { /* Sentinel */ }
 258 };
 259 MODULE_DEVICE_TABLE(of, dw8250_of_match);
 260
 261 static struct platform_driver dw8250_platform_driver = {
 262         .driver = {
 263                 .name           = "dw-apb-uart",
 264                 .owner          = THIS_MODULE,
 265                 .of_match_table = dw8250_of_match,
 266         },
 267         .probe                  = dw8250_probe,
 268         .remove                 = dw8250_remove,
 269         .suspend                = dw8250_suspend,
 270         .resume                 = dw8250_resume,
 271 };
 272
 273 module_platform_driver(dw8250_platform_driver);
 274
 275 MODULE_AUTHOR("Jamie Iles");
 276 MODULE_LICENSE("GPL");
 277 MODULE_DESCRIPTION("Synopsys DesignWare 8250 serial port driver");