drivers/tty/serial/8250/8250_fintek.c

   1 /*
   2  *  Probe for F81216A LPC to 4 UART
   3  *
   4  *  Based on drivers/tty/serial/8250_pnp.c, by Russell King, et al
   5  *
   6  *  Copyright (C) 2014 Ricardo Ribalda, Qtechnology A/S
   7  *
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License.
  12  */
  13 #include <linux/module.h>
  14 #include <linux/pci.h>
  15 #include <linux/pnp.h>
  16 #include <linux/kernel.h>
  17 #include <linux/serial_core.h>
  18 #include  "8250.h"
  19
  20 #define ADDR_PORT 0
  21 #define DATA_PORT 1
  22 #define EXIT_KEY 0xAA
  23 #define CHIP_ID1  0x20
  24 #define CHIP_ID2  0x21
  25 #define CHIP_ID_0 0x1602
  26 #define CHIP_ID_1 0x0501
  27 #define VENDOR_ID1 0x23
  28 #define VENDOR_ID1_VAL 0x19
  29 #define VENDOR_ID2 0x24
  30 #define VENDOR_ID2_VAL 0x34
  31 #define LDN 0x7
  32
  33 #define RS485  0xF0
  34 #define RTS_INVERT BIT(5)
  35 #define RS485_URA BIT(4)
  36 #define RXW4C_IRA BIT(3)
  37 #define TXW4C_IRA BIT(2)
  38
  39 #define DRIVER_NAME "8250_fintek"
  40
  41 struct fintek_8250 {
  42         u16 base_port;
  43         u8 index;
  44         u8 key;
  45         long line;
  46 };
  47
  48 static int fintek_8250_enter_key(u16 base_port, u8 key)
  49 {
  50
  51         if (!request_muxed_region(base_port, 2, DRIVER_NAME))
  52                 return -EBUSY;
  53
  54         outb(key, base_port + ADDR_PORT);
  55         outb(key, base_port + ADDR_PORT);
  56         return 0;
  57 }
  58
  59 static void fintek_8250_exit_key(u16 base_port)
  60 {
  61
  62         outb(EXIT_KEY, base_port + ADDR_PORT);
  63         release_region(base_port + ADDR_PORT, 2);
  64 }
  65
  66 static int fintek_8250_get_index(resource_size_t base_addr)
  67 {
  68         resource_size_t base[] = {0x3f8, 0x2f8, 0x3e8, 0x2e8};
  69         int i;
  70
  71         for (i = 0; i < ARRAY_SIZE(base); i++)
  72                 if (base_addr == base[i])
  73                         return i;
  74
  75         return -ENODEV;
  76 }
  77
  78 static int fintek_8250_check_id(u16 base_port)
  79 {
  80         u16 chip;
  81
  82         outb(VENDOR_ID1, base_port + ADDR_PORT);
  83         if (inb(base_port + DATA_PORT) != VENDOR_ID1_VAL)
  84                 return -ENODEV;
  85
  86         outb(VENDOR_ID2, base_port + ADDR_PORT);
  87         if (inb(base_port + DATA_PORT) != VENDOR_ID2_VAL)
  88                 return -ENODEV;
  89
  90         outb(CHIP_ID1, base_port + ADDR_PORT);
  91         chip = inb(base_port + DATA_PORT);
  92         outb(CHIP_ID2, base_port + ADDR_PORT);
  93         chip |= inb(base_port + DATA_PORT) << 8;
  94
  95         if (chip != CHIP_ID_0 && chip != CHIP_ID_1)
  96                 return -ENODEV;
  97
  98         return 0;
  99 }
 100
 101 static int fintek_8250_rs485_config(struct uart_port *port,
 102                               struct serial_rs485 *rs485)
 103 {
 104         uint8_t config = 0;
 105         struct fintek_8250 *pdata = port->private_data;
 106
 107         if (!pdata)
 108                 return -EINVAL;
 109
 110         if (rs485->flags & SER_RS485_ENABLED)
 111                 memset(rs485->padding, 0, sizeof(rs485->padding));
 112         else
 113                 memset(rs485, 0, sizeof(*rs485));
 114
 115         rs485->flags &= SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND |
 116                         SER_RS485_RTS_AFTER_SEND;
 117
 118         if (rs485->delay_rts_before_send) {
 119                 rs485->delay_rts_before_send = 1;
 120                 config |= TXW4C_IRA;
 121         }
 122
 123         if (rs485->delay_rts_after_send) {
 124                 rs485->delay_rts_after_send = 1;
 125                 config |= RXW4C_IRA;
 126         }
 127
 128         if ((!!(rs485->flags & SER_RS485_RTS_ON_SEND)) ==
 129                         (!!(rs485->flags & SER_RS485_RTS_AFTER_SEND)))
 130                 rs485->flags &= SER_RS485_ENABLED;
 131         else
 132                 config |= RS485_URA;
 133
 134         if (rs485->flags & SER_RS485_RTS_ON_SEND)
 135                 config |= RTS_INVERT;
 136
 137         if (fintek_8250_enter_key(pdata->base_port, pdata->key))
 138                 return -EBUSY;
 139
 140         outb(LDN, pdata->base_port + ADDR_PORT);
 141         outb(pdata->index, pdata->base_port + DATA_PORT);
 142         outb(RS485, pdata->base_port + ADDR_PORT);
 143         outb(config, pdata->base_port + DATA_PORT);
 144         fintek_8250_exit_key(pdata->base_port);
 145
 146         port->rs485 = *rs485;
 147
 148         return 0;
 149 }
 150
 151 static int fintek_8250_base_port(u8 *key)
 152 {
 153         static const u16 addr[] = {0x4e, 0x2e};
 154         static const u8 keys[] = {0x77, 0xa0, 0x87, 0x67};
 155         int i, j;
 156
 157         for (i = 0; i < ARRAY_SIZE(addr); i++) {
 158                 for (j = 0; j < ARRAY_SIZE(keys); j++) {
 159                         int ret;
 160
 161                         if (fintek_8250_enter_key(addr[i], keys[j]))
 162                                 continue;
 163                         ret = fintek_8250_check_id(addr[i]);
 164                         fintek_8250_exit_key(addr[i]);
 165                         if (!ret) {
 166                                 *key = keys[j];
 167                                 return addr[i];
 168                         }
 169                 }
 170         }
 171
 172         return -ENODEV;
 173 }
 174
 175 static int
 176 fintek_8250_probe(struct pnp_dev *dev, const struct pnp_device_id *dev_id)
 177 {
 178         struct uart_8250_port uart;
 179         struct fintek_8250 *pdata;
 180         int index;
 181         int base_port;
 182         u8 key;
 183
 184         if (!pnp_port_valid(dev, 0))
 185                 return -ENODEV;
 186
 187         base_port = fintek_8250_base_port(&key);
 188         if (base_port < 0)
 189                 return -ENODEV;
 190
 191         index = fintek_8250_get_index(pnp_port_start(dev, 0));
 192         if (index < 0)
 193                 return -ENODEV;
 194
 195         memset(&uart, 0, sizeof(uart));
 196
 197         pdata = devm_kzalloc(&dev->dev, sizeof(*pdata), GFP_KERNEL);
 198         if (!pdata)
 199                 return -ENOMEM;
 200         uart.port.private_data = pdata;
 201
 202         if (!pnp_irq_valid(dev, 0))
 203                 return -ENODEV;
 204         uart.port.irq = pnp_irq(dev, 0);
 205         uart.port.iobase = pnp_port_start(dev, 0);
 206         uart.port.iotype = UPIO_PORT;
 207         uart.port.rs485_config = fintek_8250_rs485_config;
 208
 209         uart.port.flags |= UPF_SKIP_TEST | UPF_BOOT_AUTOCONF;
 210         if (pnp_irq_flags(dev, 0) & IORESOURCE_IRQ_SHAREABLE)
 211                 uart.port.flags |= UPF_SHARE_IRQ;
 212         uart.port.uartclk = 1843200;
 213         uart.port.dev = &dev->dev;
 214
 215         pdata->key = key;
 216         pdata->base_port = base_port;
 217         pdata->index = index;
 218         pdata->line = serial8250_register_8250_port(&uart);
 219         if (pdata->line < 0)
 220                 return -ENODEV;
 221
 222         pnp_set_drvdata(dev, pdata);
 223         return 0;
 224 }
 225
 226 static void fintek_8250_remove(struct pnp_dev *dev)
 227 {
 228         struct fintek_8250 *pdata = pnp_get_drvdata(dev);
 229
 230         if (pdata)
 231                 serial8250_unregister_port(pdata->line);
 232 }
 233
 234 #ifdef CONFIG_PM
 235 static int fintek_8250_suspend(struct pnp_dev *dev, pm_message_t state)
 236 {
 237         struct fintek_8250 *pdata = pnp_get_drvdata(dev);
 238
 239         if (!pdata)
 240                 return -ENODEV;
 241         serial8250_suspend_port(pdata->line);
 242         return 0;
 243 }
 244
 245 static int fintek_8250_resume(struct pnp_dev *dev)
 246 {
 247         struct fintek_8250 *pdata = pnp_get_drvdata(dev);
 248
 249         if (!pdata)
 250                 return -ENODEV;
 251         serial8250_resume_port(pdata->line);
 252         return 0;
 253 }
 254 #else
 255 #define fintek_8250_suspend NULL
 256 #define fintek_8250_resume NULL
 257 #endif /* CONFIG_PM */
 258
 259 static const struct pnp_device_id fintek_dev_table[] = {
 260         /* Qtechnology Panel PC / IO1000 */
 261         { "PNP0501"},
 262         {}
 263 };
 264
 265 MODULE_DEVICE_TABLE(pnp, fintek_dev_table);
 266
 267 static struct pnp_driver fintek_8250_driver = {
 268         .name           = DRIVER_NAME,
 269         .probe          = fintek_8250_probe,
 270         .remove         = fintek_8250_remove,
 271         .suspend        = fintek_8250_suspend,
 272         .resume         = fintek_8250_resume,
 273         .id_table       = fintek_dev_table,
 274 };
 275
 276 module_pnp_driver(fintek_8250_driver);
 277 MODULE_DESCRIPTION("Fintek F812164 module");
 278 MODULE_AUTHOR("Ricardo Ribalda <ricardo.ribalda@gmail.com>");
 279 MODULE_LICENSE("GPL");