drivers/tty/serial/8250/8250_mid.c

   1 /*
   2  * 8250_mid.c - Driver for UART on Intel Penwell and various other Intel SOCs
   3  *
   4  * Copyright (C) 2015 Intel Corporation
   5  * Author: Heikki Krogerus <heikki.krogerus@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/rational.h>
  13 #include <linux/module.h>
  14 #include <linux/pci.h>
  15
  16 #include <linux/dma/hsu.h>
  17 #include <linux/8250_pci.h>
  18
  19 #include "8250.h"
  20
  21 #define PCI_DEVICE_ID_INTEL_PNW_UART1   0x081b
  22 #define PCI_DEVICE_ID_INTEL_PNW_UART2   0x081c
  23 #define PCI_DEVICE_ID_INTEL_PNW_UART3   0x081d
  24 #define PCI_DEVICE_ID_INTEL_TNG_UART    0x1191
  25 #define PCI_DEVICE_ID_INTEL_DNV_UART    0x19d8
  26
  27 /* Intel MID Specific registers */
  28 #define INTEL_MID_UART_PS               0x30
  29 #define INTEL_MID_UART_MUL              0x34
  30 #define INTEL_MID_UART_DIV              0x38
  31
  32 struct mid8250;
  33
  34 struct mid8250_board {
  35         unsigned int flags;
  36         unsigned long freq;
  37         unsigned int base_baud;
  38         int (*setup)(struct mid8250 *, struct uart_port *p);
  39         void (*exit)(struct mid8250 *);
  40 };
  41
  42 struct mid8250 {
  43         int line;
  44         int dma_index;
  45         struct pci_dev *dma_dev;
  46         struct uart_8250_dma dma;
  47         struct mid8250_board *board;
  48         struct hsu_dma_chip dma_chip;
  49 };
  50
  51 /*****************************************************************************/
  52
  53 static int pnw_setup(struct mid8250 *mid, struct uart_port *p)
  54 {
  55         struct pci_dev *pdev = to_pci_dev(p->dev);
  56
  57         switch (pdev->device) {
  58         case PCI_DEVICE_ID_INTEL_PNW_UART1:
  59                 mid->dma_index = 0;
  60                 break;
  61         case PCI_DEVICE_ID_INTEL_PNW_UART2:
  62                 mid->dma_index = 1;
  63                 break;
  64         case PCI_DEVICE_ID_INTEL_PNW_UART3:
  65                 mid->dma_index = 2;
  66                 break;
  67         default:
  68                 return -EINVAL;
  69         }
  70
  71         mid->dma_dev = pci_get_slot(pdev->bus,
  72                                     PCI_DEVFN(PCI_SLOT(pdev->devfn), 3));
  73         return 0;
  74 }
  75
  76 static int tng_setup(struct mid8250 *mid, struct uart_port *p)
  77 {
  78         struct pci_dev *pdev = to_pci_dev(p->dev);
  79         int index = PCI_FUNC(pdev->devfn);
  80
  81         /* Currently no support for HSU port0 */
  82         if (index-- == 0)
  83                 return -ENODEV;
  84
  85         mid->dma_index = index;
  86         mid->dma_dev = pci_get_slot(pdev->bus, PCI_DEVFN(5, 0));
  87         return 0;
  88 }
  89
  90 static int dnv_handle_irq(struct uart_port *p)
  91 {
  92         struct mid8250 *mid = p->private_data;
  93         int ret;
  94
  95         ret = hsu_dma_irq(&mid->dma_chip, 0);
  96         ret |= hsu_dma_irq(&mid->dma_chip, 1);
  97
  98         /* For now, letting the HW generate separate interrupt for the UART */
  99         if (ret)
 100                 return ret;
 101
 102         return serial8250_handle_irq(p, serial_port_in(p, UART_IIR));
 103 }
 104
 105 #define DNV_DMA_CHAN_OFFSET 0x80
 106
 107 static int dnv_setup(struct mid8250 *mid, struct uart_port *p)
 108 {
 109         struct hsu_dma_chip *chip = &mid->dma_chip;
 110         struct pci_dev *pdev = to_pci_dev(p->dev);
 111         unsigned int bar = FL_GET_BASE(mid->board->flags);
 112         int ret;
 113
 114         chip->dev = &pdev->dev;
 115         chip->irq = pdev->irq;
 116         chip->regs = p->membase;
 117         chip->length = pci_resource_len(pdev, bar);
 118         chip->offset = DNV_DMA_CHAN_OFFSET;
 119
 120         /* Falling back to PIO mode if DMA probing fails */
 121         ret = hsu_dma_probe(chip);
 122         if (ret)
 123                 return 0;
 124
 125         mid->dma_dev = pdev;
 126
 127         p->handle_irq = dnv_handle_irq;
 128         return 0;
 129 }
 130
 131 static void dnv_exit(struct mid8250 *mid)
 132 {
 133         if (!mid->dma_dev)
 134                 return;
 135         hsu_dma_remove(&mid->dma_chip);
 136 }
 137
 138 /*****************************************************************************/
 139
 140 static void mid8250_set_termios(struct uart_port *p,
 141                                 struct ktermios *termios,
 142                                 struct ktermios *old)
 143 {
 144         unsigned int baud = tty_termios_baud_rate(termios);
 145         struct mid8250 *mid = p->private_data;
 146         unsigned short ps = 16;
 147         unsigned long fuart = baud * ps;
 148         unsigned long w = BIT(24) - 1;
 149         unsigned long mul, div;
 150
 151         if (mid->board->freq < fuart) {
 152                 /* Find prescaler value that satisfies Fuart < Fref */
 153                 if (mid->board->freq > baud)
 154                         ps = mid->board->freq / baud;   /* baud rate too high */
 155                 else
 156                         ps = 1;                         /* PLL case */
 157                 fuart = baud * ps;
 158         } else {
 159                 /* Get Fuart closer to Fref */
 160                 fuart *= rounddown_pow_of_two(mid->board->freq / fuart);
 161         }
 162
 163         rational_best_approximation(fuart, mid->board->freq, w, w, &mul, &div);
 164         p->uartclk = fuart * 16 / ps;           /* core uses ps = 16 always */
 165
 166         writel(ps, p->membase + INTEL_MID_UART_PS);             /* set PS */
 167         writel(mul, p->membase + INTEL_MID_UART_MUL);           /* set MUL */
 168         writel(div, p->membase + INTEL_MID_UART_DIV);
 169
 170         serial8250_do_set_termios(p, termios, old);
 171 }
 172
 173 static bool mid8250_dma_filter(struct dma_chan *chan, void *param)
 174 {
 175         struct hsu_dma_slave *s = param;
 176
 177         if (s->dma_dev != chan->device->dev || s->chan_id != chan->chan_id)
 178                 return false;
 179
 180         chan->private = s;
 181         return true;
 182 }
 183
 184 static int mid8250_dma_setup(struct mid8250 *mid, struct uart_8250_port *port)
 185 {
 186         struct uart_8250_dma *dma = &mid->dma;
 187         struct device *dev = port->port.dev;
 188         struct hsu_dma_slave *rx_param;
 189         struct hsu_dma_slave *tx_param;
 190
 191         if (!mid->dma_dev)
 192                 return 0;
 193
 194         rx_param = devm_kzalloc(dev, sizeof(*rx_param), GFP_KERNEL);
 195         if (!rx_param)
 196                 return -ENOMEM;
 197
 198         tx_param = devm_kzalloc(dev, sizeof(*tx_param), GFP_KERNEL);
 199         if (!tx_param)
 200                 return -ENOMEM;
 201
 202         rx_param->chan_id = mid->dma_index * 2 + 1;
 203         tx_param->chan_id = mid->dma_index * 2;
 204
 205         dma->rxconf.src_maxburst = 64;
 206         dma->txconf.dst_maxburst = 64;
 207
 208         rx_param->dma_dev = &mid->dma_dev->dev;
 209         tx_param->dma_dev = &mid->dma_dev->dev;
 210
 211         dma->fn = mid8250_dma_filter;
 212         dma->rx_param = rx_param;
 213         dma->tx_param = tx_param;
 214
 215         port->dma = dma;
 216         return 0;
 217 }
 218
 219 static int mid8250_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 220 {
 221         struct uart_8250_port uart;
 222         struct mid8250 *mid;
 223         unsigned int bar;
 224         int ret;
 225
 226         ret = pcim_enable_device(pdev);
 227         if (ret)
 228                 return ret;
 229
 230         pci_set_master(pdev);
 231
 232         mid = devm_kzalloc(&pdev->dev, sizeof(*mid), GFP_KERNEL);
 233         if (!mid)
 234                 return -ENOMEM;
 235
 236         mid->board = (struct mid8250_board *)id->driver_data;
 237         bar = FL_GET_BASE(mid->board->flags);
 238
 239         memset(&uart, 0, sizeof(struct uart_8250_port));
 240
 241         uart.port.dev = &pdev->dev;
 242         uart.port.irq = pdev->irq;
 243         uart.port.private_data = mid;
 244         uart.port.type = PORT_16750;
 245         uart.port.iotype = UPIO_MEM;
 246         uart.port.uartclk = mid->board->base_baud * 16;
 247         uart.port.flags = UPF_SHARE_IRQ | UPF_FIXED_PORT | UPF_FIXED_TYPE;
 248         uart.port.set_termios = mid8250_set_termios;
 249
 250         uart.port.mapbase = pci_resource_start(pdev, bar);
 251         uart.port.membase = pcim_iomap(pdev, bar, 0);
 252         if (!uart.port.membase)
 253                 return -ENOMEM;
 254
 255         if (mid->board->setup) {
 256                 ret = mid->board->setup(mid, &uart.port);
 257                 if (ret)
 258                         return ret;
 259         }
 260
 261         ret = mid8250_dma_setup(mid, &uart);
 262         if (ret)
 263                 goto err;
 264
 265         ret = serial8250_register_8250_port(&uart);
 266         if (ret < 0)
 267                 goto err;
 268
 269         mid->line = ret;
 270
 271         pci_set_drvdata(pdev, mid);
 272         return 0;
 273 err:
 274         if (mid->board->exit)
 275                 mid->board->exit(mid);
 276         return ret;
 277 }
 278
 279 static void mid8250_remove(struct pci_dev *pdev)
 280 {
 281         struct mid8250 *mid = pci_get_drvdata(pdev);
 282
 283         if (mid->board->exit)
 284                 mid->board->exit(mid);
 285
 286         serial8250_unregister_port(mid->line);
 287 }
 288
 289 static const struct mid8250_board pnw_board = {
 290         .flags = FL_BASE0,
 291         .freq = 50000000,
 292         .base_baud = 115200,
 293         .setup = pnw_setup,
 294 };
 295
 296 static const struct mid8250_board tng_board = {
 297         .flags = FL_BASE0,
 298         .freq = 38400000,
 299         .base_baud = 1843200,
 300         .setup = tng_setup,
 301 };
 302
 303 static const struct mid8250_board dnv_board = {
 304         .flags = FL_BASE1,
 305         .freq = 133333333,
 306         .base_baud = 115200,
 307         .setup = dnv_setup,
 308         .exit = dnv_exit,
 309 };
 310
 311 #define MID_DEVICE(id, board) { PCI_VDEVICE(INTEL, id), (kernel_ulong_t)&board }
 312
 313 static const struct pci_device_id pci_ids[] = {
 314         MID_DEVICE(PCI_DEVICE_ID_INTEL_PNW_UART1, pnw_board),
 315         MID_DEVICE(PCI_DEVICE_ID_INTEL_PNW_UART2, pnw_board),
 316         MID_DEVICE(PCI_DEVICE_ID_INTEL_PNW_UART3, pnw_board),
 317         MID_DEVICE(PCI_DEVICE_ID_INTEL_TNG_UART, tng_board),
 318         MID_DEVICE(PCI_DEVICE_ID_INTEL_DNV_UART, dnv_board),
 319         { },
 320 };
 321 MODULE_DEVICE_TABLE(pci, pci_ids);
 322
 323 static struct pci_driver mid8250_pci_driver = {
 324         .name           = "8250_mid",
 325         .id_table       = pci_ids,
 326         .probe          = mid8250_probe,
 327         .remove         = mid8250_remove,
 328 };
 329
 330 module_pci_driver(mid8250_pci_driver);
 331
 332 MODULE_AUTHOR("Intel Corporation");
 333 MODULE_LICENSE("GPL v2");
 334 MODULE_DESCRIPTION("Intel MID UART driver");