xref: /dragonfly/sys/bus/smbus/ichsmb/ichsmb_pci.c (revision c8860c9a)
1 /*-
2  * ichsmb_pci.c
3  *
4  * Author: Archie Cobbs <archie@freebsd.org>
5  * Copyright (c) 2000 Whistle Communications, Inc.
6  * All rights reserved.
7  * Author: Archie Cobbs <archie@freebsd.org>
8  *
9  * Subject to the following obligations and disclaimer of warranty, use and
10  * redistribution of this software, in source or object code forms, with or
11  * without modifications are expressly permitted by Whistle Communications;
12  * provided, however, that:
13  * 1. Any and all reproductions of the source or object code must include the
14  *    copyright notice above and the following disclaimer of warranties; and
15  * 2. No rights are granted, in any manner or form, to use Whistle
16  *    Communications, Inc. trademarks, including the mark "WHISTLE
17  *    COMMUNICATIONS" on advertising, endorsements, or otherwise except as
18  *    such appears in the above copyright notice or in the software.
19  *
20  * THIS SOFTWARE IS BEING PROVIDED BY WHISTLE COMMUNICATIONS "AS IS", AND
21  * TO THE MAXIMUM EXTENT PERMITTED BY LAW, WHISTLE COMMUNICATIONS MAKES NO
22  * REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, REGARDING THIS SOFTWARE,
23  * INCLUDING WITHOUT LIMITATION, ANY AND ALL IMPLIED WARRANTIES OF
24  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
25  * WHISTLE COMMUNICATIONS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY
26  * REPRESENTATIONS REGARDING THE USE OF, OR THE RESULTS OF THE USE OF THIS
27  * SOFTWARE IN TERMS OF ITS CORRECTNESS, ACCURACY, RELIABILITY OR OTHERWISE.
28  * IN NO EVENT SHALL WHISTLE COMMUNICATIONS BE LIABLE FOR ANY DAMAGES
29  * RESULTING FROM OR ARISING OUT OF ANY USE OF THIS SOFTWARE, INCLUDING
30  * WITHOUT LIMITATION, ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
31  * PUNITIVE, OR CONSEQUENTIAL DAMAGES, PROCUREMENT OF SUBSTITUTE GOODS OR
32  * SERVICES, LOSS OF USE, DATA OR PROFITS, HOWEVER CAUSED AND UNDER ANY
33  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35  * THIS SOFTWARE, EVEN IF WHISTLE COMMUNICATIONS IS ADVISED OF THE POSSIBILITY
36  * OF SUCH DAMAGE.
37  *
38  * $FreeBSD: src/sys/dev/ichsmb/ichsmb_pci.c,v 1.25 2009/12/16 12:25:27 avg Exp $
39  */
40 
41 /*
42  * Support for the SMBus controller logical device which is part of the
43  * Intel 81801AA/AB/BA/CA/DC/EB (ICH/ICH[02345]) I/O controller hub chips.
44  */
45 
46 #include <sys/param.h>
47 #include <sys/systm.h>
48 #include <sys/kernel.h>
49 #include <sys/module.h>
50 #include <sys/errno.h>
51 #include <sys/lock.h>
52 #include <sys/syslog.h>
53 #include <sys/bus.h>
54 
55 #include <sys/rman.h>
56 
57 #include <bus/pci/pcivar.h>
58 #include <bus/pci/pcireg.h>
59 
60 #include <bus/smbus/smbconf.h>
61 
62 #include <bus/smbus/ichsmb/ichsmb_var.h>
63 #include <bus/smbus/ichsmb/ichsmb_reg.h>
64 
65 /* PCI unique identifiers */
66 #define PCI_VENDOR_INTEL		0x8086
67 #define ID_82801AA			0x2413
68 #define ID_82801AB			0x2423
69 #define ID_82801BA			0x2443
70 #define ID_82801CA			0x2483
71 #define ID_82801DC			0x24C3
72 #define ID_82801EB			0x24D3
73 #define ID_82801FB			0x266A
74 #define ID_82801GB			0x27da
75 #define ID_82801H			0x283e
76 #define ID_82801I			0x2930
77 #define ID_EP80579			0x5032
78 #define ID_82801JI			0x3a30
79 #define ID_82801JD			0x3a60
80 #define ID_PCH				0x3b30
81 #define ID_6300ESB			0x25a4
82 #define ID_631xESB			0x269b
83 #define ID_DH89XXCC			0x2330
84 #define ID_PATSBURG			0x1d22
85 #define ID_CPT				0x1c22
86 #define ID_PPT				0x1e22
87 #define ID_AVOTON			0x1f3c
88 #define ID_COLETOCRK			0x23B0
89 #define ID_LPT				0x8c22
90 #define ID_LPTLP			0x9c22
91 #define ID_WCPT				0x8ca2
92 #define ID_WCPTLP			0x9ca2
93 #define ID_BAYTRAIL			0x0f12
94 #define ID_BRASWELL			0x2292
95 #define ID_WELLSBURG			0x8d22
96 #define ID_SRPT				0xa123
97 #define ID_SRPTLP			0x9d23
98 #define ID_DENVERTON			0x19df
99 #define ID_BROXTON			0x5ad4
100 #define ID_LEWISBURG			0xa1a3
101 #define ID_LEWISBURG2			0xa223
102 #define ID_KABYLAKE			0xa2a3
103 #define ID_CANNONLAKE			0xa323
104 #define ID_COMETLAKE			0x02a3
105 #define ID_COMETLAKE2			0x06a3
106 #define ID_TIGERLAKE			0xa0a3
107 #define ID_TIGERLAKE2			0x43a3
108 #define ID_GEMINILAKE			0x31d4
109 
110 static const struct ichsmb_device {
111 	uint16_t	id;
112 	const char	*name;
113 } ichsmb_devices[] = {
114 	{ ID_82801AA,	"Intel 82801AA (ICH) SMBus controller"		},
115 	{ ID_82801AB,	"Intel 82801AB (ICH0) SMBus controller"		},
116 	{ ID_82801BA,	"Intel 82801BA (ICH2) SMBus controller"		},
117 	{ ID_82801CA,	"Intel 82801CA (ICH3) SMBus controller"		},
118 	{ ID_82801DC,	"Intel 82801DC (ICH4) SMBus controller"		},
119 	{ ID_82801EB,	"Intel 82801EB (ICH5) SMBus controller"		},
120 	{ ID_82801FB,	"Intel 82801FB (ICH6) SMBus controller"		},
121 	{ ID_82801GB,	"Intel 82801GB (ICH7) SMBus controller"		},
122 	{ ID_82801H,	"Intel 82801H (ICH8) SMBus controller"		},
123 	{ ID_82801I,	"Intel 82801I (ICH9) SMBus controller"		},
124 	{ ID_82801GB,	"Intel 82801GB (ICH7) SMBus controller"		},
125 	{ ID_82801H,	"Intel 82801H (ICH8) SMBus controller"		},
126 	{ ID_82801I,	"Intel 82801I (ICH9) SMBus controller"		},
127 	{ ID_EP80579,	"Intel EP80579 SMBus controller"		},
128 	{ ID_82801JI,	"Intel 82801JI (ICH10) SMBus controller"	},
129 	{ ID_82801JD,	"Intel 82801JD (ICH10) SMBus controller"	},
130 	{ ID_PCH,	"Intel PCH SMBus controller"			},
131 	{ ID_6300ESB,	"Intel 6300ESB (ICH) SMBus controller"		},
132 	{ ID_631xESB,	"Intel 631xESB/6321ESB (ESB2) SMBus controller"	},
133 	{ ID_DH89XXCC,	"Intel DH89xxCC SMBus controller"		},
134 	{ ID_PATSBURG,	"Intel Patsburg SMBus controller"		},
135 	{ ID_CPT,	"Intel Cougar Point SMBus controller"		},
136 	{ ID_PPT,	"Intel Panther Point SMBus controller"		},
137 	{ ID_AVOTON,	"Intel Avoton SMBus controller"			},
138 	{ ID_LPT,	"Intel Lynx Point SMBus controller"		},
139 	{ ID_LPTLP,	"Intel Lynx Point-LP SMBus controller"		},
140 	{ ID_WCPT,	"Intel Wildcat Point SMBus controller"		},
141 	{ ID_WCPTLP,	"Intel Wildcat Point-LP SMBus controller"	},
142 	{ ID_BAYTRAIL,	"Intel Baytrail SMBus controller"		},
143 	{ ID_BRASWELL,	"Intel Braswell SMBus controller"		},
144 	{ ID_COLETOCRK,	"Intel Coleto Creek SMBus controller"		},
145 	{ ID_WELLSBURG,	"Intel Wellsburg SMBus controller"		},
146 	{ ID_SRPT,	"Intel Sunrise Point-H SMBus controller"	},
147 	{ ID_SRPTLP,	"Intel Sunrise Point-LP SMBus controller"	},
148 	{ ID_DENVERTON,	"Intel Denverton SMBus controller"		},
149 	{ ID_BROXTON,	"Intel Broxton SMBus controller"		},
150 	{ ID_LEWISBURG,	"Intel Lewisburg SMBus controller"		},
151 	{ ID_LEWISBURG2,"Intel Lewisburg SMBus controller"		},
152 	{ ID_KABYLAKE,	"Intel Kaby Lake SMBus controller"		},
153 	{ ID_CANNONLAKE,"Intel Cannon Lake SMBus controller"		},
154 	{ ID_COMETLAKE,	"Intel Comet Lake SMBus controller"		},
155 	{ ID_COMETLAKE2,"Intel Comet Lake SMBus controller"		},
156 	{ ID_TIGERLAKE,	"Intel Tiger Lake SMBus controller"		},
157 	{ ID_TIGERLAKE2,"Intel Tiger Lake SMBus controller"		},
158 	{ ID_GEMINILAKE,"Intel Gemini Lake SMBus controller"		},
159 	{ 0, NULL },
160 };
161 
162 /* Internal functions */
163 static int	ichsmb_pci_probe(device_t dev);
164 static int	ichsmb_pci_attach(device_t dev);
165 /*Use generic one for now*/
166 #if 0
167 static int	ichsmb_pci_detach(device_t dev);
168 #endif
169 
170 /* Device methods */
171 static device_method_t ichsmb_pci_methods[] = {
172 	/* Device interface */
173         DEVMETHOD(device_probe, ichsmb_pci_probe),
174         DEVMETHOD(device_attach, ichsmb_pci_attach),
175         DEVMETHOD(device_detach, ichsmb_detach),
176 
177 	/* Bus methods */
178         DEVMETHOD(bus_print_child, bus_generic_print_child),
179 
180 	/* SMBus methods */
181         DEVMETHOD(smbus_callback, ichsmb_callback),
182         DEVMETHOD(smbus_quick, ichsmb_quick),
183         DEVMETHOD(smbus_sendb, ichsmb_sendb),
184         DEVMETHOD(smbus_recvb, ichsmb_recvb),
185         DEVMETHOD(smbus_writeb, ichsmb_writeb),
186         DEVMETHOD(smbus_writew, ichsmb_writew),
187         DEVMETHOD(smbus_readb, ichsmb_readb),
188         DEVMETHOD(smbus_readw, ichsmb_readw),
189         DEVMETHOD(smbus_pcall, ichsmb_pcall),
190         DEVMETHOD(smbus_bwrite, ichsmb_bwrite),
191         DEVMETHOD(smbus_bread, ichsmb_bread),
192 	DEVMETHOD_END
193 };
194 
195 static driver_t ichsmb_pci_driver = {
196 	"ichsmb",
197 	ichsmb_pci_methods,
198 	sizeof(struct ichsmb_softc)
199 };
200 
201 static devclass_t ichsmb_pci_devclass;
202 
203 DRIVER_MODULE(ichsmb, pci, ichsmb_pci_driver, ichsmb_pci_devclass, NULL, NULL);
204 
205 static int
206 ichsmb_pci_probe(device_t dev)
207 {
208 	const struct ichsmb_device *device;
209 
210 	for (device = ichsmb_devices; device->name != NULL; device++) {
211 		if (pci_get_device(dev) == device->id) {
212 			device_set_desc(dev, device->name);
213 			return (ichsmb_probe(dev));
214 		}
215 	}
216 
217 	return (ENXIO);
218 }
219 
220 static int
221 ichsmb_pci_attach(device_t dev)
222 {
223 	const sc_p sc = device_get_softc(dev);
224 	int error;
225 
226 	/* Initialize private state */
227 	bzero(sc, sizeof(*sc));
228 	sc->ich_cmd = -1;
229 	sc->dev = dev;
230 
231 	/* Allocate an I/O range */
232 	sc->io_rid = ICH_SMB_BASE;
233 	sc->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
234 	    &sc->io_rid, 0, ~0, 16, RF_ACTIVE);
235 	if (sc->io_res == NULL)
236 		sc->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
237 		    &sc->io_rid, 0ul, ~0ul, 32, RF_ACTIVE);
238 	if (sc->io_res == NULL) {
239 		device_printf(dev, "can't map I/O\n");
240 		error = ENXIO;
241 		goto fail;
242 	}
243 
244 	/* Allocate interrupt */
245 	sc->irq_rid = 0;
246 	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
247 	    &sc->irq_rid, RF_ACTIVE | RF_SHAREABLE);
248 	if (sc->irq_res == NULL) {
249 		device_printf(dev, "can't get IRQ\n");
250 		error = ENXIO;
251 		goto fail;
252 	}
253 
254 	/* Enable device */
255 	pci_write_config(dev, ICH_HOSTC, ICH_HOSTC_HST_EN, 1);
256 
257 	/* Done */
258 	error = ichsmb_attach(dev);
259 	if (error)
260 		goto fail;
261 	return (0);
262 
263 fail:
264 	/* Attach failed, release resources */
265 	ichsmb_release_resources(sc);
266 	return (error);
267 }
268 
269 
270 MODULE_DEPEND(ichsmb, pci, 1, 1, 1);
271 MODULE_DEPEND(ichsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
272 MODULE_VERSION(ichsmb, 1);
273