xref: /freebsd/sys/dev/ichsmb/ichsmb_pci.c (revision ec273ebf3b6aed5fba8c56b6ece5ad8693a48ea7)
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 
39 #include <sys/cdefs.h>
40 __FBSDID("$FreeBSD$");
41 
42 /*
43  * Support for the SMBus controller logical device which is part of the
44  * Intel 81801AA/AB/BA/CA/DC/EB (ICH/ICH[02345]) I/O controller hub chips.
45  */
46 
47 #include <sys/param.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/module.h>
51 #include <sys/errno.h>
52 #include <sys/lock.h>
53 #include <sys/mutex.h>
54 #include <sys/syslog.h>
55 #include <sys/bus.h>
56 
57 #include <machine/bus.h>
58 #include <sys/rman.h>
59 #include <machine/resource.h>
60 
61 #include <dev/pci/pcivar.h>
62 #include <dev/pci/pcireg.h>
63 
64 #include <dev/smbus/smbconf.h>
65 
66 #include <dev/ichsmb/ichsmb_var.h>
67 #include <dev/ichsmb/ichsmb_reg.h>
68 
69 /* PCI unique identifiers */
70 #define ID_82801AA			0x24138086
71 #define ID_82801AB			0x24238086
72 #define ID_82801BA			0x24438086
73 #define ID_82801CA			0x24838086
74 #define ID_82801DC			0x24C38086
75 #define ID_82801EB			0x24D38086
76 #define ID_82801FB			0x266A8086
77 #define ID_82801GB			0x27da8086
78 #define ID_82801H			0x283e8086
79 #define ID_82801I			0x29308086
80 #define ID_82801JI			0x3a308086
81 #define ID_PCH				0x3b308086
82 #define ID_6300ESB			0x25a48086
83 #define	ID_631xESB			0x269b8086
84 #define ID_DH89XXCC			0x23308086
85 #define ID_PATSBURG			0x1d228086
86 #define ID_CPT				0x1c228086
87 #define ID_PPT				0x1e228086
88 #define ID_AVOTON			0x1f3c8086
89 #define ID_COLETOCRK			0x23B08086
90 #define ID_LPT				0x8c228086
91 #define ID_WCPT				0x8ca28086
92 
93 #define PCIS_SERIALBUS_SMBUS_PROGIF	0x00
94 
95 /* Internal functions */
96 static int	ichsmb_pci_probe(device_t dev);
97 static int	ichsmb_pci_attach(device_t dev);
98 /*Use generic one for now*/
99 #if 0
100 static int	ichsmb_pci_detach(device_t dev);
101 #endif
102 
103 /* Device methods */
104 static device_method_t ichsmb_pci_methods[] = {
105 	/* Device interface */
106         DEVMETHOD(device_probe, ichsmb_pci_probe),
107         DEVMETHOD(device_attach, ichsmb_pci_attach),
108         DEVMETHOD(device_detach, ichsmb_detach),
109 
110 	/* SMBus methods */
111         DEVMETHOD(smbus_callback, ichsmb_callback),
112         DEVMETHOD(smbus_quick, ichsmb_quick),
113         DEVMETHOD(smbus_sendb, ichsmb_sendb),
114         DEVMETHOD(smbus_recvb, ichsmb_recvb),
115         DEVMETHOD(smbus_writeb, ichsmb_writeb),
116         DEVMETHOD(smbus_writew, ichsmb_writew),
117         DEVMETHOD(smbus_readb, ichsmb_readb),
118         DEVMETHOD(smbus_readw, ichsmb_readw),
119         DEVMETHOD(smbus_pcall, ichsmb_pcall),
120         DEVMETHOD(smbus_bwrite, ichsmb_bwrite),
121         DEVMETHOD(smbus_bread, ichsmb_bread),
122 
123 	DEVMETHOD_END
124 };
125 
126 static driver_t ichsmb_pci_driver = {
127 	"ichsmb",
128 	ichsmb_pci_methods,
129 	sizeof(struct ichsmb_softc)
130 };
131 
132 static devclass_t ichsmb_pci_devclass;
133 
134 DRIVER_MODULE(ichsmb, pci, ichsmb_pci_driver, ichsmb_pci_devclass, 0, 0);
135 
136 static int
137 ichsmb_pci_probe(device_t dev)
138 {
139 	/* Check PCI identifier */
140 	switch (pci_get_devid(dev)) {
141 	case ID_82801AA:
142 		device_set_desc(dev, "Intel 82801AA (ICH) SMBus controller");
143 		break;
144 	case ID_82801AB:
145 		device_set_desc(dev, "Intel 82801AB (ICH0) SMBus controller");
146 		break;
147 	case ID_82801BA:
148 		device_set_desc(dev, "Intel 82801BA (ICH2) SMBus controller");
149 		break;
150 	case ID_82801CA:
151 		device_set_desc(dev, "Intel 82801CA (ICH3) SMBus controller");
152 		break;
153 	case ID_82801DC:
154 		device_set_desc(dev, "Intel 82801DC (ICH4) SMBus controller");
155 		break;
156 	case ID_82801EB:
157 		device_set_desc(dev, "Intel 82801EB (ICH5) SMBus controller");
158 		break;
159 	case ID_82801FB:
160 		device_set_desc(dev, "Intel 82801FB (ICH6) SMBus controller");
161 		break;
162 	case ID_82801GB:
163 		device_set_desc(dev, "Intel 82801GB (ICH7) SMBus controller");
164 		break;
165 	case ID_82801H:
166 		device_set_desc(dev, "Intel 82801H (ICH8) SMBus controller");
167 		break;
168 	case ID_82801I:
169 		device_set_desc(dev, "Intel 82801I (ICH9) SMBus controller");
170 		break;
171 	case ID_82801JI:
172 		device_set_desc(dev, "Intel 82801JI (ICH10) SMBus controller");
173 		break;
174 	case ID_PCH:
175 		device_set_desc(dev, "Intel PCH SMBus controller");
176 		break;
177 	case ID_6300ESB:
178 		device_set_desc(dev, "Intel 6300ESB (ICH) SMBus controller");
179 		break;
180 	case ID_631xESB:
181 		device_set_desc(dev, "Intel 631xESB/6321ESB (ESB2) SMBus controller");
182 		break;
183 	case ID_DH89XXCC:
184 		device_set_desc(dev, "Intel DH89xxCC SMBus controller");
185 		break;
186 	case ID_PATSBURG:
187 		device_set_desc(dev, "Intel Patsburg SMBus controller");
188 		break;
189 	case ID_CPT:
190 		device_set_desc(dev, "Intel Cougar Point SMBus controller");
191 		break;
192 	case ID_PPT:
193 		device_set_desc(dev, "Intel Panther Point SMBus controller");
194 		break;
195 	case ID_AVOTON:
196 		device_set_desc(dev, "Intel Avoton SMBus controller");
197 		break;
198 	case ID_LPT:
199 		device_set_desc(dev, "Intel Lynx Point SMBus controller");
200 		break;
201 	case ID_WCPT:
202 		device_set_desc(dev, "Intel Wildcat Point SMBus controller");
203 		break;
204 	case ID_COLETOCRK:
205 		device_set_desc(dev, "Intel Coleto Creek SMBus controller");
206 		break;
207 	default:
208 		return (ENXIO);
209 	}
210 
211 	/* Done */
212 	return (ichsmb_probe(dev));
213 }
214 
215 static int
216 ichsmb_pci_attach(device_t dev)
217 {
218 	const sc_p sc = device_get_softc(dev);
219 	int error;
220 
221 	/* Initialize private state */
222 	bzero(sc, sizeof(*sc));
223 	sc->ich_cmd = -1;
224 	sc->dev = dev;
225 
226 	/* Allocate an I/O range */
227 	sc->io_rid = ICH_SMB_BASE;
228 	sc->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
229 	    &sc->io_rid, 0, ~0, 16, RF_ACTIVE);
230 	if (sc->io_res == NULL)
231 		sc->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
232 		    &sc->io_rid, 0ul, ~0ul, 32, RF_ACTIVE);
233 	if (sc->io_res == NULL) {
234 		device_printf(dev, "can't map I/O\n");
235 		error = ENXIO;
236 		goto fail;
237 	}
238 
239 	/* Allocate interrupt */
240 	sc->irq_rid = 0;
241 	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
242 	    &sc->irq_rid, RF_ACTIVE | RF_SHAREABLE);
243 	if (sc->irq_res == NULL) {
244 		device_printf(dev, "can't get IRQ\n");
245 		error = ENXIO;
246 		goto fail;
247 	}
248 
249 	/* Enable device */
250 	pci_write_config(dev, ICH_HOSTC, ICH_HOSTC_HST_EN, 1);
251 
252 	/* Done */
253 	error = ichsmb_attach(dev);
254 	if (error)
255 		goto fail;
256 	return (0);
257 
258 fail:
259 	/* Attach failed, release resources */
260 	ichsmb_release_resources(sc);
261 	return (error);
262 }
263 
264 
265 MODULE_DEPEND(ichsmb, pci, 1, 1, 1);
266 MODULE_DEPEND(ichsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
267 MODULE_VERSION(ichsmb, 1);
268