1/*-
2 * Copyright (c) 2006 Marcel Moolenaar
3 * Copyright (c) 2001 M. Warner Losh
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 *    notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 *    notice, this list of conditions and the following disclaimer in the
13 *    documentation and/or other materials provided with the distribution.
14 *
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25 */
26
27#include <sys/cdefs.h>
28__FBSDID("$FreeBSD: stable/11/sys/dev/uart/uart_bus_pci.c 358552 2020-03-02 18:06:02Z jhibbits $");
29
30#include <sys/param.h>
31#include <sys/systm.h>
32#include <sys/bus.h>
33#include <sys/conf.h>
34#include <sys/kernel.h>
35#include <sys/module.h>
36#include <machine/bus.h>
37#include <sys/rman.h>
38#include <machine/resource.h>
39
40#include <dev/pci/pcivar.h>
41
42#include <dev/uart/uart.h>
43#include <dev/uart/uart_bus.h>
44
45#define	DEFAULT_RCLK	1843200
46
47static int uart_pci_probe(device_t dev);
48
49static device_method_t uart_pci_methods[] = {
50	/* Device interface */
51	DEVMETHOD(device_probe,		uart_pci_probe),
52	DEVMETHOD(device_attach,	uart_bus_attach),
53	DEVMETHOD(device_detach,	uart_bus_detach),
54	DEVMETHOD(device_resume,	uart_bus_resume),
55	DEVMETHOD_END
56};
57
58static driver_t uart_pci_driver = {
59	uart_driver_name,
60	uart_pci_methods,
61	sizeof(struct uart_softc),
62};
63
64struct pci_id {
65	uint16_t	vendor;
66	uint16_t	device;
67	uint16_t	subven;
68	uint16_t	subdev;
69	const char	*desc;
70	int		rid;
71	int		rclk;
72	int		regshft;
73};
74
75static const struct pci_id pci_ns8250_ids[] = {
76{ 0x1028, 0x0008, 0xffff, 0, "Dell Remote Access Card III", 0x14,
77	128 * DEFAULT_RCLK },
78{ 0x1028, 0x0012, 0xffff, 0, "Dell RAC 4 Daughter Card Virtual UART", 0x14,
79	128 * DEFAULT_RCLK },
80{ 0x1033, 0x0074, 0x1033, 0x8014, "NEC RCV56ACF 56k Voice Modem", 0x10 },
81{ 0x1033, 0x007d, 0x1033, 0x8012, "NEC RS232C", 0x10 },
82{ 0x103c, 0x1048, 0x103c, 0x1227, "HP Diva Serial [GSP] UART - Powerbar SP2",
83	0x10 },
84{ 0x103c, 0x1048, 0x103c, 0x1301, "HP Diva RMP3", 0x14 },
85{ 0x103c, 0x1290, 0xffff, 0, "HP Auxiliary Diva Serial Port", 0x18 },
86{ 0x103c, 0x3301, 0xffff, 0, "HP iLO serial port", 0x10 },
87{ 0x11c1, 0x0480, 0xffff, 0, "Agere Systems Venus Modem (V90, 56KFlex)", 0x14 },
88{ 0x115d, 0x0103, 0xffff, 0, "Xircom Cardbus Ethernet + 56k Modem", 0x10 },
89{ 0x125b, 0x9100, 0xa000, 0x1000,
90	"ASIX AX99100 PCIe 1/2/3/4-port RS-232/422/485", 0x10 },
91{ 0x1282, 0x6585, 0xffff, 0, "Davicom 56PDV PCI Modem", 0x10 },
92{ 0x12b9, 0x1008, 0xffff, 0, "3Com 56K FaxModem Model 5610", 0x10 },
93{ 0x131f, 0x1000, 0xffff, 0, "Siig CyberSerial (1-port) 16550", 0x18 },
94{ 0x131f, 0x1001, 0xffff, 0, "Siig CyberSerial (1-port) 16650", 0x18 },
95{ 0x131f, 0x1002, 0xffff, 0, "Siig CyberSerial (1-port) 16850", 0x18 },
96{ 0x131f, 0x2000, 0xffff, 0, "Siig CyberSerial (1-port) 16550", 0x10 },
97{ 0x131f, 0x2001, 0xffff, 0, "Siig CyberSerial (1-port) 16650", 0x10 },
98{ 0x131f, 0x2002, 0xffff, 0, "Siig CyberSerial (1-port) 16850", 0x10 },
99{ 0x135c, 0x0190, 0xffff, 0, "Quatech SSCLP-100", 0x18 },
100{ 0x135c, 0x01c0, 0xffff, 0, "Quatech SSCLP-200/300", 0x18 },
101{ 0x135e, 0x7101, 0xffff, 0, "Sealevel Systems Single Port RS-232/422/485/530",
102	0x18 },
103{ 0x1407, 0x0110, 0xffff, 0, "Lava Computer mfg DSerial-PCI Port A", 0x10 },
104{ 0x1407, 0x0111, 0xffff, 0, "Lava Computer mfg DSerial-PCI Port B", 0x10 },
105{ 0x1407, 0x0510, 0xffff, 0, "Lava SP Serial 550 PCI", 0x10 },
106{ 0x1409, 0x7168, 0x1409, 0x4025, "Timedia Technology Serial Port", 0x10,
107	8 * DEFAULT_RCLK },
108{ 0x1409, 0x7168, 0x1409, 0x4027, "Timedia Technology Serial Port", 0x10,
109	8 * DEFAULT_RCLK },
110{ 0x1409, 0x7168, 0x1409, 0x4028, "Timedia Technology Serial Port", 0x10,
111	8 * DEFAULT_RCLK },
112{ 0x1409, 0x7168, 0x1409, 0x5025, "Timedia Technology Serial Port", 0x10,
113	8 * DEFAULT_RCLK },
114{ 0x1409, 0x7168, 0x1409, 0x5027, "Timedia Technology Serial Port", 0x10,
115	8 * DEFAULT_RCLK },
116{ 0x1415, 0x950b, 0xffff, 0, "Oxford Semiconductor OXCB950 Cardbus 16950 UART",
117	0x10, 16384000 },
118{ 0x1415, 0xc120, 0xffff, 0, "Oxford Semiconductor OXPCIe952 PCIe 16950 UART",
119	0x10 },
120{ 0x14e4, 0x160a, 0xffff, 0, "Broadcom TruManage UART", 0x10,
121	128 * DEFAULT_RCLK, 2},
122{ 0x14e4, 0x4344, 0xffff, 0, "Sony Ericsson GC89 PC Card", 0x10},
123{ 0x151f, 0x0000, 0xffff, 0, "TOPIC Semiconductor TP560 56k modem", 0x10 },
124{ 0x1fd4, 0x1999, 0x1fd4, 0x0001, "Sunix SER5xxxx Serial Port", 0x10,
125	8 * DEFAULT_RCLK },
126{ 0x8086, 0x0f0a, 0xffff, 0, "Intel ValleyView LPIO1 HSUART#1", 0x10,
127	24 * DEFAULT_RCLK, 2 },
128{ 0x8086, 0x0f0c, 0xffff, 0, "Intel ValleyView LPIO1 HSUART#2", 0x10,
129	24 * DEFAULT_RCLK, 2 },
130{ 0x8086, 0x108f, 0xffff, 0, "Intel AMT - SOL", 0x10 },
131{ 0x8086, 0x19d8, 0xffff, 0, "Intel Denverton UART", 0x10 },
132{ 0x8086, 0x1c3d, 0xffff, 0, "Intel AMT - KT Controller", 0x10 },
133{ 0x8086, 0x1d3d, 0xffff, 0, "Intel C600/X79 Series Chipset KT Controller", 0x10 },
134{ 0x8086, 0x1e3d, 0xffff, 0, "Intel Panther Point KT Controller", 0x10 },
135{ 0x8086, 0x228a, 0xffff, 0, "Intel Cherryview SIO HSUART#1", 0x10,
136       24 * DEFAULT_RCLK, 2 },
137{ 0x8086, 0x228c, 0xffff, 0, "Intel Cherryview SIO HSUART#2", 0x10,
138       24 * DEFAULT_RCLK, 2 },
139{ 0x8086, 0x2a07, 0xffff, 0, "Intel AMT - PM965/GM965 KT Controller", 0x10 },
140{ 0x8086, 0x2a47, 0xffff, 0, "Mobile 4 Series Chipset KT Controller", 0x10 },
141{ 0x8086, 0x2e17, 0xffff, 0, "4 Series Chipset Serial KT Controller", 0x10 },
142{ 0x8086, 0x3b67, 0xffff, 0, "5 Series/3400 Series Chipset KT Controller",
143	0x10 },
144{ 0x8086, 0x8811, 0xffff, 0, "Intel EG20T Serial Port 0", 0x10 },
145{ 0x8086, 0x8812, 0xffff, 0, "Intel EG20T Serial Port 1", 0x10 },
146{ 0x8086, 0x8813, 0xffff, 0, "Intel EG20T Serial Port 2", 0x10 },
147{ 0x8086, 0x8814, 0xffff, 0, "Intel EG20T Serial Port 3", 0x10 },
148{ 0x8086, 0x8c3d, 0xffff, 0, "Intel Lynx Point KT Controller", 0x10 },
149{ 0x8086, 0x8cbd, 0xffff, 0, "Intel Wildcat Point KT Controller", 0x10 },
150{ 0x8086, 0x9c3d, 0xffff, 0, "Intel Lynx Point-LP HECI KT", 0x10 },
151{ 0x9710, 0x9820, 0x1000, 1, "NetMos NM9820 Serial Port", 0x10 },
152{ 0x9710, 0x9835, 0x1000, 1, "NetMos NM9835 Serial Port", 0x10 },
153{ 0x9710, 0x9865, 0xa000, 0x1000, "NetMos NM9865 Serial Port", 0x10 },
154{ 0x9710, 0x9900, 0xa000, 0x1000,
155	"MosChip MCS9900 PCIe to Peripheral Controller", 0x10 },
156{ 0x9710, 0x9901, 0xa000, 0x1000,
157	"MosChip MCS9901 PCIe to Peripheral Controller", 0x10 },
158{ 0x9710, 0x9904, 0xa000, 0x1000,
159	"MosChip MCS9904 PCIe to Peripheral Controller", 0x10 },
160{ 0x9710, 0x9922, 0xa000, 0x1000,
161	"MosChip MCS9922 PCIe to Peripheral Controller", 0x10 },
162{ 0xdeaf, 0x9051, 0xffff, 0, "Middle Digital PC Weasel Serial Port", 0x10 },
163{ 0xffff, 0, 0xffff, 0, NULL, 0, 0}
164};
165
166const static struct pci_id *
167uart_pci_match(device_t dev, const struct pci_id *id)
168{
169	uint16_t device, subdev, subven, vendor;
170
171	vendor = pci_get_vendor(dev);
172	device = pci_get_device(dev);
173	while (id->vendor != 0xffff &&
174	    (id->vendor != vendor || id->device != device))
175		id++;
176	if (id->vendor == 0xffff)
177		return (NULL);
178	if (id->subven == 0xffff)
179		return (id);
180	subven = pci_get_subvendor(dev);
181	subdev = pci_get_subdevice(dev);
182	while (id->vendor == vendor && id->device == device &&
183	    (id->subven != subven || id->subdev != subdev))
184		id++;
185	return ((id->vendor == vendor && id->device == device) ? id : NULL);
186}
187
188static int
189uart_pci_probe(device_t dev)
190{
191	struct uart_softc *sc;
192	const struct pci_id *id;
193	int result;
194
195	sc = device_get_softc(dev);
196
197	id = uart_pci_match(dev, pci_ns8250_ids);
198	if (id != NULL) {
199		sc->sc_class = &uart_ns8250_class;
200		goto match;
201	}
202	/* Add checks for non-ns8250 IDs here. */
203	return (ENXIO);
204
205 match:
206	result = uart_bus_probe(dev, id->regshft, 0, id->rclk, id->rid, 0, 0);
207	/* Bail out on error. */
208	if (result > 0)
209		return (result);
210	/* Set/override the device description. */
211	if (id->desc)
212		device_set_desc(dev, id->desc);
213	return (result);
214}
215
216DRIVER_MODULE(uart, pci, uart_pci_driver, uart_devclass, NULL, NULL);
217