drivers/tty/serial/8250/8250_lpss.c

   1 /*
   2  * 8250_lpss.c - Driver for UART on Intel Braswell and various other Intel SoCs
   3  *
   4  * Copyright (C) 2016 Intel Corporation
   5  * Author: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11
  12 #include <linux/bitops.h>
  13 #include <linux/module.h>
  14 #include <linux/pci.h>
  15 #include <linux/rational.h>
  16
  17 #include <linux/dmaengine.h>
  18 #include <linux/platform_data/dma-dw.h>
  19
  20 #include "8250.h"
  21
  22 #define PCI_DEVICE_ID_INTEL_QRK_UARTx   0x0936
  23
  24 #define PCI_DEVICE_ID_INTEL_BYT_UART1   0x0f0a
  25 #define PCI_DEVICE_ID_INTEL_BYT_UART2   0x0f0c
  26
  27 #define PCI_DEVICE_ID_INTEL_BSW_UART1   0x228a
  28 #define PCI_DEVICE_ID_INTEL_BSW_UART2   0x228c
  29
  30 #define PCI_DEVICE_ID_INTEL_BDW_UART1   0x9ce3
  31 #define PCI_DEVICE_ID_INTEL_BDW_UART2   0x9ce4
  32
  33 /* Intel LPSS specific registers */
  34
  35 #define BYT_PRV_CLK                     0x800
  36 #define BYT_PRV_CLK_EN                  BIT(0)
  37 #define BYT_PRV_CLK_M_VAL_SHIFT         1
  38 #define BYT_PRV_CLK_N_VAL_SHIFT         16
  39 #define BYT_PRV_CLK_UPDATE              BIT(31)
  40
  41 #define BYT_TX_OVF_INT                  0x820
  42 #define BYT_TX_OVF_INT_MASK             BIT(1)
  43
  44 struct lpss8250;
  45
  46 struct lpss8250_board {
  47         unsigned long freq;
  48         unsigned int base_baud;
  49         int (*setup)(struct lpss8250 *, struct uart_port *p);
  50 };
  51
  52 struct lpss8250 {
  53         int line;
  54         struct lpss8250_board *board;
  55
  56         /* DMA parameters */
  57         struct uart_8250_dma dma;
  58         struct dw_dma_slave dma_param;
  59         u8 dma_maxburst;
  60 };
  61
  62 static void byt_set_termios(struct uart_port *p, struct ktermios *termios,
  63                             struct ktermios *old)
  64 {
  65         unsigned int baud = tty_termios_baud_rate(termios);
  66         struct lpss8250 *lpss = p->private_data;
  67         unsigned long fref = lpss->board->freq, fuart = baud * 16;
  68         unsigned long w = BIT(15) - 1;
  69         unsigned long m, n;
  70         u32 reg;
  71
  72         /* Gracefully handle the B0 case: fall back to B9600 */
  73         fuart = fuart ? fuart : 9600 * 16;
  74
  75         /* Get Fuart closer to Fref */
  76         fuart *= rounddown_pow_of_two(fref / fuart);
  77
  78         /*
  79          * For baud rates 0.5M, 1M, 1.5M, 2M, 2.5M, 3M, 3.5M and 4M the
  80          * dividers must be adjusted.
  81          *
  82          * uartclk = (m / n) * 100 MHz, where m <= n
  83          */
  84         rational_best_approximation(fuart, fref, w, w, &m, &n);
  85         p->uartclk = fuart;
  86
  87         /* Reset the clock */
  88         reg = (m << BYT_PRV_CLK_M_VAL_SHIFT) | (n << BYT_PRV_CLK_N_VAL_SHIFT);
  89         writel(reg, p->membase + BYT_PRV_CLK);
  90         reg |= BYT_PRV_CLK_EN | BYT_PRV_CLK_UPDATE;
  91         writel(reg, p->membase + BYT_PRV_CLK);
  92
  93         p->status &= ~UPSTAT_AUTOCTS;
  94         if (termios->c_cflag & CRTSCTS)
  95                 p->status |= UPSTAT_AUTOCTS;
  96
  97         serial8250_do_set_termios(p, termios, old);
  98 }
  99
 100 static unsigned int byt_get_mctrl(struct uart_port *port)
 101 {
 102         unsigned int ret = serial8250_do_get_mctrl(port);
 103
 104         /* Force DCD and DSR signals to permanently be reported as active */
 105         ret |= TIOCM_CAR | TIOCM_DSR;
 106
 107         return ret;
 108 }
 109
 110 static int byt_serial_setup(struct lpss8250 *lpss, struct uart_port *port)
 111 {
 112         struct dw_dma_slave *param = &lpss->dma_param;
 113         struct uart_8250_port *up = up_to_u8250p(port);
 114         struct pci_dev *pdev = to_pci_dev(port->dev);
 115         unsigned int dma_devfn = PCI_DEVFN(PCI_SLOT(pdev->devfn), 0);
 116         struct pci_dev *dma_dev = pci_get_slot(pdev->bus, dma_devfn);
 117
 118         switch (pdev->device) {
 119         case PCI_DEVICE_ID_INTEL_BYT_UART1:
 120         case PCI_DEVICE_ID_INTEL_BSW_UART1:
 121         case PCI_DEVICE_ID_INTEL_BDW_UART1:
 122                 param->src_id = 3;
 123                 param->dst_id = 2;
 124                 break;
 125         case PCI_DEVICE_ID_INTEL_BYT_UART2:
 126         case PCI_DEVICE_ID_INTEL_BSW_UART2:
 127         case PCI_DEVICE_ID_INTEL_BDW_UART2:
 128                 param->src_id = 5;
 129                 param->dst_id = 4;
 130                 break;
 131         default:
 132                 return -EINVAL;
 133         }
 134
 135         param->dma_dev = &dma_dev->dev;
 136         param->m_master = 0;
 137         param->p_master = 1;
 138
 139         /* TODO: Detect FIFO size automaticaly for DesignWare 8250 */
 140         port->fifosize = 64;
 141         up->tx_loadsz = 64;
 142
 143         lpss->dma_maxburst = 16;
 144
 145         port->set_termios = byt_set_termios;
 146         port->get_mctrl = byt_get_mctrl;
 147
 148         /* Disable TX counter interrupts */
 149         writel(BYT_TX_OVF_INT_MASK, port->membase + BYT_TX_OVF_INT);
 150
 151         return 0;
 152 }
 153
 154 static bool lpss8250_dma_filter(struct dma_chan *chan, void *param)
 155 {
 156         struct dw_dma_slave *dws = param;
 157
 158         if (dws->dma_dev != chan->device->dev)
 159                 return false;
 160
 161         chan->private = dws;
 162         return true;
 163 }
 164
 165 static int lpss8250_dma_setup(struct lpss8250 *lpss, struct uart_8250_port *port)
 166 {
 167         struct uart_8250_dma *dma = &lpss->dma;
 168         struct dw_dma_slave *rx_param, *tx_param;
 169         struct device *dev = port->port.dev;
 170
 171         if (!lpss->dma_param.dma_dev)
 172                 return 0;
 173
 174         rx_param = devm_kzalloc(dev, sizeof(*rx_param), GFP_KERNEL);
 175         if (!rx_param)
 176                 return -ENOMEM;
 177
 178         tx_param = devm_kzalloc(dev, sizeof(*tx_param), GFP_KERNEL);
 179         if (!tx_param)
 180                 return -ENOMEM;
 181
 182         *rx_param = lpss->dma_param;
 183         dma->rxconf.src_maxburst = lpss->dma_maxburst;
 184
 185         *tx_param = lpss->dma_param;
 186         dma->txconf.dst_maxburst = lpss->dma_maxburst;
 187
 188         dma->fn = lpss8250_dma_filter;
 189         dma->rx_param = rx_param;
 190         dma->tx_param = tx_param;
 191
 192         port->dma = dma;
 193         return 0;
 194 }
 195
 196 static int lpss8250_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 197 {
 198         struct uart_8250_port uart;
 199         struct lpss8250 *lpss;
 200         int ret;
 201
 202         ret = pcim_enable_device(pdev);
 203         if (ret)
 204                 return ret;
 205
 206         pci_set_master(pdev);
 207
 208         lpss = devm_kzalloc(&pdev->dev, sizeof(*lpss), GFP_KERNEL);
 209         if (!lpss)
 210                 return -ENOMEM;
 211
 212         lpss->board = (struct lpss8250_board *)id->driver_data;
 213
 214         memset(&uart, 0, sizeof(struct uart_8250_port));
 215
 216         uart.port.dev = &pdev->dev;
 217         uart.port.irq = pdev->irq;
 218         uart.port.private_data = lpss;
 219         uart.port.type = PORT_16550A;
 220         uart.port.iotype = UPIO_MEM;
 221         uart.port.regshift = 2;
 222         uart.port.uartclk = lpss->board->base_baud * 16;
 223         uart.port.flags = UPF_SHARE_IRQ | UPF_FIXED_PORT | UPF_FIXED_TYPE;
 224         uart.capabilities = UART_CAP_FIFO | UART_CAP_AFE;
 225         uart.port.mapbase = pci_resource_start(pdev, 0);
 226         uart.port.membase = pcim_iomap(pdev, 0, 0);
 227         if (!uart.port.membase)
 228                 return -ENOMEM;
 229
 230         ret = lpss->board->setup(lpss, &uart.port);
 231         if (ret)
 232                 return ret;
 233
 234         ret = lpss8250_dma_setup(lpss, &uart);
 235         if (ret)
 236                 return ret;
 237
 238         ret = serial8250_register_8250_port(&uart);
 239         if (ret < 0)
 240                 return ret;
 241
 242         lpss->line = ret;
 243
 244         pci_set_drvdata(pdev, lpss);
 245         return 0;
 246 }
 247
 248 static void lpss8250_remove(struct pci_dev *pdev)
 249 {
 250         struct lpss8250 *lpss = pci_get_drvdata(pdev);
 251
 252         serial8250_unregister_port(lpss->line);
 253 }
 254
 255 static const struct lpss8250_board byt_board = {
 256         .freq = 100000000,
 257         .base_baud = 2764800,
 258         .setup = byt_serial_setup,
 259 };
 260
 261 static const struct lpss8250_board qrk_board = {
 262         .freq = 44236800,
 263         .base_baud = 2764800,
 264 };
 265
 266 #define LPSS_DEVICE(id, board) { PCI_VDEVICE(INTEL, id), (kernel_ulong_t)&board }
 267
 268 static const struct pci_device_id pci_ids[] = {
 269         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_QRK_UARTx, qrk_board),
 270         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_BYT_UART1, byt_board),
 271         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_BYT_UART2, byt_board),
 272         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_BSW_UART1, byt_board),
 273         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_BSW_UART2, byt_board),
 274         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_BDW_UART1, byt_board),
 275         LPSS_DEVICE(PCI_DEVICE_ID_INTEL_BDW_UART2, byt_board),
 276         { },
 277 };
 278 MODULE_DEVICE_TABLE(pci, pci_ids);
 279
 280 static struct pci_driver lpss8250_pci_driver = {
 281         .name           = "8250_lpss",
 282         .id_table       = pci_ids,
 283         .probe          = lpss8250_probe,
 284         .remove         = lpss8250_remove,
 285 };
 286
 287 module_pci_driver(lpss8250_pci_driver);
 288
 289 MODULE_AUTHOR("Intel Corporation");
 290 MODULE_LICENSE("GPL v2");
 291 MODULE_DESCRIPTION("Intel LPSS UART driver");