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

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