xref: /openbmc/linux/drivers/tty/serial/8250/8250_fintek.c (revision 06e3957259ef9003061c3c153232266ab8967e34)
128e3fb6cSRicardo Ribalda Delgado /*
228e3fb6cSRicardo Ribalda Delgado  *  Probe for F81216A LPC to 4 UART
328e3fb6cSRicardo Ribalda Delgado  *
4fa01e2caSRicardo Ribalda Delgado  *  Copyright (C) 2014-2016 Ricardo Ribalda, Qtechnology A/S
528e3fb6cSRicardo Ribalda Delgado  *
628e3fb6cSRicardo Ribalda Delgado  *
728e3fb6cSRicardo Ribalda Delgado  * This program is free software; you can redistribute it and/or modify
828e3fb6cSRicardo Ribalda Delgado  * it under the terms of the GNU General Public License as published by
928e3fb6cSRicardo Ribalda Delgado  * the Free Software Foundation; either version 2 of the License.
1028e3fb6cSRicardo Ribalda Delgado  */
1128e3fb6cSRicardo Ribalda Delgado #include <linux/module.h>
1228e3fb6cSRicardo Ribalda Delgado #include <linux/pci.h>
1328e3fb6cSRicardo Ribalda Delgado #include <linux/pnp.h>
1428e3fb6cSRicardo Ribalda Delgado #include <linux/kernel.h>
1528e3fb6cSRicardo Ribalda Delgado #include <linux/serial_core.h>
164da22f14SJi-Ze Hong (Peter Hong) #include <linux/irq.h>
1728e3fb6cSRicardo Ribalda Delgado #include  "8250.h"
1828e3fb6cSRicardo Ribalda Delgado 
19017bec38SRicardo Ribalda Delgado #define ADDR_PORT 0
20017bec38SRicardo Ribalda Delgado #define DATA_PORT 1
2128e3fb6cSRicardo Ribalda Delgado #define EXIT_KEY 0xAA
2228e3fb6cSRicardo Ribalda Delgado #define CHIP_ID1  0x20
2328e3fb6cSRicardo Ribalda Delgado #define CHIP_ID2  0x21
24dae77f75SRicardo Ribalda Delgado #define CHIP_ID_0 0x1602
25dae77f75SRicardo Ribalda Delgado #define CHIP_ID_1 0x0501
2628e3fb6cSRicardo Ribalda Delgado #define VENDOR_ID1 0x23
2728e3fb6cSRicardo Ribalda Delgado #define VENDOR_ID1_VAL 0x19
2828e3fb6cSRicardo Ribalda Delgado #define VENDOR_ID2 0x24
2928e3fb6cSRicardo Ribalda Delgado #define VENDOR_ID2_VAL 0x34
3029d58642SRicardo Ribalda Delgado #define IO_ADDR1 0x61
3129d58642SRicardo Ribalda Delgado #define IO_ADDR2 0x60
3228e3fb6cSRicardo Ribalda Delgado #define LDN 0x7
3328e3fb6cSRicardo Ribalda Delgado 
3487a713c8SArnd Bergmann #define FINTEK_IRQ_MODE	0x70
354da22f14SJi-Ze Hong (Peter Hong) #define IRQ_SHARE	BIT(4)
364da22f14SJi-Ze Hong (Peter Hong) #define IRQ_MODE_MASK	(BIT(6) | BIT(5))
374da22f14SJi-Ze Hong (Peter Hong) #define IRQ_LEVEL_LOW	0
384da22f14SJi-Ze Hong (Peter Hong) #define IRQ_EDGE_HIGH	BIT(5)
394da22f14SJi-Ze Hong (Peter Hong) 
4028e3fb6cSRicardo Ribalda Delgado #define RS485  0xF0
4128e3fb6cSRicardo Ribalda Delgado #define RTS_INVERT BIT(5)
4228e3fb6cSRicardo Ribalda Delgado #define RS485_URA BIT(4)
4328e3fb6cSRicardo Ribalda Delgado #define RXW4C_IRA BIT(3)
4428e3fb6cSRicardo Ribalda Delgado #define TXW4C_IRA BIT(2)
4528e3fb6cSRicardo Ribalda Delgado 
4692a5f11aSRicardo Ribalda Delgado struct fintek_8250 {
47017bec38SRicardo Ribalda Delgado 	u16 base_port;
4892a5f11aSRicardo Ribalda Delgado 	u8 index;
49ce8c267eSRicardo Ribalda Delgado 	u8 key;
5092a5f11aSRicardo Ribalda Delgado };
5192a5f11aSRicardo Ribalda Delgado 
52f1232ac2SJi-Ze Hong (Peter Hong) static u8 sio_read_reg(struct fintek_8250 *pdata, u8 reg)
53f1232ac2SJi-Ze Hong (Peter Hong) {
54f1232ac2SJi-Ze Hong (Peter Hong) 	outb(reg, pdata->base_port + ADDR_PORT);
55f1232ac2SJi-Ze Hong (Peter Hong) 	return inb(pdata->base_port + DATA_PORT);
56f1232ac2SJi-Ze Hong (Peter Hong) }
57f1232ac2SJi-Ze Hong (Peter Hong) 
58f1232ac2SJi-Ze Hong (Peter Hong) static void sio_write_reg(struct fintek_8250 *pdata, u8 reg, u8 data)
59f1232ac2SJi-Ze Hong (Peter Hong) {
60f1232ac2SJi-Ze Hong (Peter Hong) 	outb(reg, pdata->base_port + ADDR_PORT);
61f1232ac2SJi-Ze Hong (Peter Hong) 	outb(data, pdata->base_port + DATA_PORT);
62f1232ac2SJi-Ze Hong (Peter Hong) }
63f1232ac2SJi-Ze Hong (Peter Hong) 
64f1232ac2SJi-Ze Hong (Peter Hong) static void sio_write_mask_reg(struct fintek_8250 *pdata, u8 reg, u8 mask,
65f1232ac2SJi-Ze Hong (Peter Hong) 			       u8 data)
66f1232ac2SJi-Ze Hong (Peter Hong) {
67f1232ac2SJi-Ze Hong (Peter Hong) 	u8 tmp;
68f1232ac2SJi-Ze Hong (Peter Hong) 
69f1232ac2SJi-Ze Hong (Peter Hong) 	tmp = (sio_read_reg(pdata, reg) & ~mask) | (mask & data);
70f1232ac2SJi-Ze Hong (Peter Hong) 	sio_write_reg(pdata, reg, tmp);
71f1232ac2SJi-Ze Hong (Peter Hong) }
72f1232ac2SJi-Ze Hong (Peter Hong) 
73ce8c267eSRicardo Ribalda Delgado static int fintek_8250_enter_key(u16 base_port, u8 key)
74017bec38SRicardo Ribalda Delgado {
75fa01e2caSRicardo Ribalda Delgado 	if (!request_muxed_region(base_port, 2, "8250_fintek"))
7628e3fb6cSRicardo Ribalda Delgado 		return -EBUSY;
7728e3fb6cSRicardo Ribalda Delgado 
78ce8c267eSRicardo Ribalda Delgado 	outb(key, base_port + ADDR_PORT);
79ce8c267eSRicardo Ribalda Delgado 	outb(key, base_port + ADDR_PORT);
8028e3fb6cSRicardo Ribalda Delgado 	return 0;
8128e3fb6cSRicardo Ribalda Delgado }
8228e3fb6cSRicardo Ribalda Delgado 
83017bec38SRicardo Ribalda Delgado static void fintek_8250_exit_key(u16 base_port)
84017bec38SRicardo Ribalda Delgado {
8528e3fb6cSRicardo Ribalda Delgado 
86017bec38SRicardo Ribalda Delgado 	outb(EXIT_KEY, base_port + ADDR_PORT);
87017bec38SRicardo Ribalda Delgado 	release_region(base_port + ADDR_PORT, 2);
8828e3fb6cSRicardo Ribalda Delgado }
8928e3fb6cSRicardo Ribalda Delgado 
90f1232ac2SJi-Ze Hong (Peter Hong) static int fintek_8250_check_id(struct fintek_8250 *pdata)
9128e3fb6cSRicardo Ribalda Delgado {
92dae77f75SRicardo Ribalda Delgado 	u16 chip;
9328e3fb6cSRicardo Ribalda Delgado 
94f1232ac2SJi-Ze Hong (Peter Hong) 	if (sio_read_reg(pdata, VENDOR_ID1) != VENDOR_ID1_VAL)
9528e3fb6cSRicardo Ribalda Delgado 		return -ENODEV;
9628e3fb6cSRicardo Ribalda Delgado 
97f1232ac2SJi-Ze Hong (Peter Hong) 	if (sio_read_reg(pdata, VENDOR_ID2) != VENDOR_ID2_VAL)
9828e3fb6cSRicardo Ribalda Delgado 		return -ENODEV;
9928e3fb6cSRicardo Ribalda Delgado 
100f1232ac2SJi-Ze Hong (Peter Hong) 	chip = sio_read_reg(pdata, CHIP_ID1);
101f1232ac2SJi-Ze Hong (Peter Hong) 	chip |= sio_read_reg(pdata, CHIP_ID2) << 8;
102dae77f75SRicardo Ribalda Delgado 
103dae77f75SRicardo Ribalda Delgado 	if (chip != CHIP_ID_0 && chip != CHIP_ID_1)
104dae77f75SRicardo Ribalda Delgado 		return -ENODEV;
105dae77f75SRicardo Ribalda Delgado 
10628e3fb6cSRicardo Ribalda Delgado 	return 0;
10728e3fb6cSRicardo Ribalda Delgado }
10828e3fb6cSRicardo Ribalda Delgado 
10941e69093SRicardo Ribalda Delgado static int fintek_8250_rs485_config(struct uart_port *port,
11028e3fb6cSRicardo Ribalda Delgado 			      struct serial_rs485 *rs485)
11128e3fb6cSRicardo Ribalda Delgado {
11228e3fb6cSRicardo Ribalda Delgado 	uint8_t config = 0;
11392a5f11aSRicardo Ribalda Delgado 	struct fintek_8250 *pdata = port->private_data;
11428e3fb6cSRicardo Ribalda Delgado 
11592a5f11aSRicardo Ribalda Delgado 	if (!pdata)
11628e3fb6cSRicardo Ribalda Delgado 		return -EINVAL;
11728e3fb6cSRicardo Ribalda Delgado 
11828e3fb6cSRicardo Ribalda Delgado 	if (rs485->flags & SER_RS485_ENABLED)
11928e3fb6cSRicardo Ribalda Delgado 		memset(rs485->padding, 0, sizeof(rs485->padding));
12028e3fb6cSRicardo Ribalda Delgado 	else
12128e3fb6cSRicardo Ribalda Delgado 		memset(rs485, 0, sizeof(*rs485));
12228e3fb6cSRicardo Ribalda Delgado 
12328e3fb6cSRicardo Ribalda Delgado 	rs485->flags &= SER_RS485_ENABLED | SER_RS485_RTS_ON_SEND |
12428e3fb6cSRicardo Ribalda Delgado 			SER_RS485_RTS_AFTER_SEND;
12528e3fb6cSRicardo Ribalda Delgado 
12628e3fb6cSRicardo Ribalda Delgado 	if (rs485->delay_rts_before_send) {
12728e3fb6cSRicardo Ribalda Delgado 		rs485->delay_rts_before_send = 1;
12828e3fb6cSRicardo Ribalda Delgado 		config |= TXW4C_IRA;
12928e3fb6cSRicardo Ribalda Delgado 	}
13028e3fb6cSRicardo Ribalda Delgado 
13128e3fb6cSRicardo Ribalda Delgado 	if (rs485->delay_rts_after_send) {
13228e3fb6cSRicardo Ribalda Delgado 		rs485->delay_rts_after_send = 1;
13328e3fb6cSRicardo Ribalda Delgado 		config |= RXW4C_IRA;
13428e3fb6cSRicardo Ribalda Delgado 	}
13528e3fb6cSRicardo Ribalda Delgado 
13628e3fb6cSRicardo Ribalda Delgado 	if ((!!(rs485->flags & SER_RS485_RTS_ON_SEND)) ==
13728e3fb6cSRicardo Ribalda Delgado 			(!!(rs485->flags & SER_RS485_RTS_AFTER_SEND)))
13828e3fb6cSRicardo Ribalda Delgado 		rs485->flags &= SER_RS485_ENABLED;
13928e3fb6cSRicardo Ribalda Delgado 	else
14028e3fb6cSRicardo Ribalda Delgado 		config |= RS485_URA;
14128e3fb6cSRicardo Ribalda Delgado 
14228e3fb6cSRicardo Ribalda Delgado 	if (rs485->flags & SER_RS485_RTS_ON_SEND)
14328e3fb6cSRicardo Ribalda Delgado 		config |= RTS_INVERT;
14428e3fb6cSRicardo Ribalda Delgado 
145ce8c267eSRicardo Ribalda Delgado 	if (fintek_8250_enter_key(pdata->base_port, pdata->key))
14628e3fb6cSRicardo Ribalda Delgado 		return -EBUSY;
14728e3fb6cSRicardo Ribalda Delgado 
148f1232ac2SJi-Ze Hong (Peter Hong) 	sio_write_reg(pdata, LDN, pdata->index);
149f1232ac2SJi-Ze Hong (Peter Hong) 	sio_write_reg(pdata, RS485, config);
150017bec38SRicardo Ribalda Delgado 	fintek_8250_exit_key(pdata->base_port);
15128e3fb6cSRicardo Ribalda Delgado 
15241e69093SRicardo Ribalda Delgado 	port->rs485 = *rs485;
15341e69093SRicardo Ribalda Delgado 
15428e3fb6cSRicardo Ribalda Delgado 	return 0;
15528e3fb6cSRicardo Ribalda Delgado }
15628e3fb6cSRicardo Ribalda Delgado 
157*06e39572SJi-Ze Hong (Peter Hong) static void fintek_8250_set_irq_mode(struct fintek_8250 *pdata, bool is_level)
158*06e39572SJi-Ze Hong (Peter Hong) {
159*06e39572SJi-Ze Hong (Peter Hong) 	sio_write_reg(pdata, LDN, pdata->index);
160*06e39572SJi-Ze Hong (Peter Hong) 	sio_write_mask_reg(pdata, FINTEK_IRQ_MODE, IRQ_SHARE, IRQ_SHARE);
161*06e39572SJi-Ze Hong (Peter Hong) 	sio_write_mask_reg(pdata, FINTEK_IRQ_MODE, IRQ_MODE_MASK,
162*06e39572SJi-Ze Hong (Peter Hong) 			   is_level ? IRQ_LEVEL_LOW : IRQ_EDGE_HIGH);
163*06e39572SJi-Ze Hong (Peter Hong) }
164*06e39572SJi-Ze Hong (Peter Hong) 
165*06e39572SJi-Ze Hong (Peter Hong) static int probe_setup_port(struct fintek_8250 *pdata, u16 io_address,
166*06e39572SJi-Ze Hong (Peter Hong) 			  unsigned int irq)
167017bec38SRicardo Ribalda Delgado {
168017bec38SRicardo Ribalda Delgado 	static const u16 addr[] = {0x4e, 0x2e};
169ce8c267eSRicardo Ribalda Delgado 	static const u8 keys[] = {0x77, 0xa0, 0x87, 0x67};
170*06e39572SJi-Ze Hong (Peter Hong) 	struct irq_data *irq_data;
171*06e39572SJi-Ze Hong (Peter Hong) 	bool level_mode = false;
17229d58642SRicardo Ribalda Delgado 	int i, j, k;
173017bec38SRicardo Ribalda Delgado 
174017bec38SRicardo Ribalda Delgado 	for (i = 0; i < ARRAY_SIZE(addr); i++) {
175ce8c267eSRicardo Ribalda Delgado 		for (j = 0; j < ARRAY_SIZE(keys); j++) {
176f1232ac2SJi-Ze Hong (Peter Hong) 			pdata->base_port = addr[i];
177f1232ac2SJi-Ze Hong (Peter Hong) 			pdata->key = keys[j];
178017bec38SRicardo Ribalda Delgado 
179ce8c267eSRicardo Ribalda Delgado 			if (fintek_8250_enter_key(addr[i], keys[j]))
180017bec38SRicardo Ribalda Delgado 				continue;
181f1232ac2SJi-Ze Hong (Peter Hong) 			if (fintek_8250_check_id(pdata)) {
182017bec38SRicardo Ribalda Delgado 				fintek_8250_exit_key(addr[i]);
18329d58642SRicardo Ribalda Delgado 				continue;
18429d58642SRicardo Ribalda Delgado 			}
18529d58642SRicardo Ribalda Delgado 
18629d58642SRicardo Ribalda Delgado 			for (k = 0; k < 4; k++) {
18729d58642SRicardo Ribalda Delgado 				u16 aux;
18829d58642SRicardo Ribalda Delgado 
189f1232ac2SJi-Ze Hong (Peter Hong) 				sio_write_reg(pdata, LDN, k);
190f1232ac2SJi-Ze Hong (Peter Hong) 				aux = sio_read_reg(pdata, IO_ADDR1);
191f1232ac2SJi-Ze Hong (Peter Hong) 				aux |= sio_read_reg(pdata, IO_ADDR2) << 8;
19229d58642SRicardo Ribalda Delgado 				if (aux != io_address)
19329d58642SRicardo Ribalda Delgado 					continue;
19429d58642SRicardo Ribalda Delgado 
195fa01e2caSRicardo Ribalda Delgado 				pdata->index = k;
196fa01e2caSRicardo Ribalda Delgado 
197*06e39572SJi-Ze Hong (Peter Hong) 				irq_data = irq_get_irq_data(irq);
198*06e39572SJi-Ze Hong (Peter Hong) 				if (irq_data)
199*06e39572SJi-Ze Hong (Peter Hong) 					level_mode =
200*06e39572SJi-Ze Hong (Peter Hong) 						irqd_is_level_type(irq_data);
201*06e39572SJi-Ze Hong (Peter Hong) 
202*06e39572SJi-Ze Hong (Peter Hong) 				fintek_8250_set_irq_mode(pdata, level_mode);
203*06e39572SJi-Ze Hong (Peter Hong) 				fintek_8250_exit_key(addr[i]);
204*06e39572SJi-Ze Hong (Peter Hong) 
205fa01e2caSRicardo Ribalda Delgado 				return 0;
206017bec38SRicardo Ribalda Delgado 			}
207fa01e2caSRicardo Ribalda Delgado 
20829d58642SRicardo Ribalda Delgado 			fintek_8250_exit_key(addr[i]);
209ce8c267eSRicardo Ribalda Delgado 		}
210ce8c267eSRicardo Ribalda Delgado 	}
211017bec38SRicardo Ribalda Delgado 
212017bec38SRicardo Ribalda Delgado 	return -ENODEV;
213017bec38SRicardo Ribalda Delgado }
214017bec38SRicardo Ribalda Delgado 
215fa01e2caSRicardo Ribalda Delgado int fintek_8250_probe(struct uart_8250_port *uart)
21628e3fb6cSRicardo Ribalda Delgado {
21792a5f11aSRicardo Ribalda Delgado 	struct fintek_8250 *pdata;
218fa01e2caSRicardo Ribalda Delgado 	struct fintek_8250 probe_data;
21928e3fb6cSRicardo Ribalda Delgado 
220*06e39572SJi-Ze Hong (Peter Hong) 	if (probe_setup_port(&probe_data, uart->port.iobase, uart->port.irq))
22128e3fb6cSRicardo Ribalda Delgado 		return -ENODEV;
22228e3fb6cSRicardo Ribalda Delgado 
223fa01e2caSRicardo Ribalda Delgado 	pdata = devm_kzalloc(uart->port.dev, sizeof(*pdata), GFP_KERNEL);
22492a5f11aSRicardo Ribalda Delgado 	if (!pdata)
22592a5f11aSRicardo Ribalda Delgado 		return -ENOMEM;
22692a5f11aSRicardo Ribalda Delgado 
227fa01e2caSRicardo Ribalda Delgado 	memcpy(pdata, &probe_data, sizeof(probe_data));
228fa01e2caSRicardo Ribalda Delgado 	uart->port.rs485_config = fintek_8250_rs485_config;
229fa01e2caSRicardo Ribalda Delgado 	uart->port.private_data = pdata;
23028e3fb6cSRicardo Ribalda Delgado 
231*06e39572SJi-Ze Hong (Peter Hong) 	return 0;
23228e3fb6cSRicardo Ribalda Delgado }
233