xref: /freebsd/sys/dev/ichsmb/ichsmb_pci.c (revision 35a04710d7286aa9538917fd7f8e417dbee95b82)
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_6300ESB			0x25a48086
79 #define	ID_631xESB			0x269b8086
80 
81 #define PCIS_SERIALBUS_SMBUS_PROGIF	0x00
82 
83 /* Internal functions */
84 static int	ichsmb_pci_probe(device_t dev);
85 static int	ichsmb_pci_attach(device_t dev);
86 /*Use generic one for now*/
87 #if 0
88 static int	ichsmb_pci_detach(device_t dev);
89 #endif
90 
91 /* Device methods */
92 static device_method_t ichsmb_pci_methods[] = {
93 	/* Device interface */
94         DEVMETHOD(device_probe, ichsmb_pci_probe),
95         DEVMETHOD(device_attach, ichsmb_pci_attach),
96         DEVMETHOD(device_detach, ichsmb_detach),
97 
98 	/* Bus methods */
99         DEVMETHOD(bus_print_child, bus_generic_print_child),
100 
101 	/* SMBus methods */
102         DEVMETHOD(smbus_callback, ichsmb_callback),
103         DEVMETHOD(smbus_quick, ichsmb_quick),
104         DEVMETHOD(smbus_sendb, ichsmb_sendb),
105         DEVMETHOD(smbus_recvb, ichsmb_recvb),
106         DEVMETHOD(smbus_writeb, ichsmb_writeb),
107         DEVMETHOD(smbus_writew, ichsmb_writew),
108         DEVMETHOD(smbus_readb, ichsmb_readb),
109         DEVMETHOD(smbus_readw, ichsmb_readw),
110         DEVMETHOD(smbus_pcall, ichsmb_pcall),
111         DEVMETHOD(smbus_bwrite, ichsmb_bwrite),
112         DEVMETHOD(smbus_bread, ichsmb_bread),
113 	{ 0, 0 }
114 };
115 
116 static driver_t ichsmb_pci_driver = {
117 	"ichsmb",
118 	ichsmb_pci_methods,
119 	sizeof(struct ichsmb_softc)
120 };
121 
122 static devclass_t ichsmb_pci_devclass;
123 
124 DRIVER_MODULE(ichsmb, pci, ichsmb_pci_driver, ichsmb_pci_devclass, 0, 0);
125 
126 static int
127 ichsmb_pci_probe(device_t dev)
128 {
129 	/* Check PCI identifier */
130 	switch (pci_get_devid(dev)) {
131 	case ID_82801AA:
132 		device_set_desc(dev, "Intel 82801AA (ICH) SMBus controller");
133 		break;
134 	case ID_82801AB:
135 		device_set_desc(dev, "Intel 82801AB (ICH0) SMBus controller");
136 		break;
137 	case ID_82801BA:
138 		device_set_desc(dev, "Intel 82801BA (ICH2) SMBus controller");
139 		break;
140 	case ID_82801CA:
141 		device_set_desc(dev, "Intel 82801CA (ICH3) SMBus controller");
142 		break;
143 	case ID_82801DC:
144 		device_set_desc(dev, "Intel 82801DC (ICH4) SMBus controller");
145 		break;
146 	case ID_82801EB:
147 		device_set_desc(dev, "Intel 82801EB (ICH5) SMBus controller");
148 		break;
149 	case ID_82801FB:
150 		device_set_desc(dev, "Intel 82801FB (ICH6) SMBus controller");
151 		break;
152 	case ID_82801GB:
153 		device_set_desc(dev, "Intel 82801GB (ICH7) SMBus controller");
154 		break;
155 	case ID_6300ESB:
156 		device_set_desc(dev, "Intel 6300ESB (ICH) SMBus controller");
157 		break;
158 	case ID_631xESB:
159 		device_set_desc(dev, "Intel 631xESB/6321ESB (ESB2) SMBus controller");
160 		break;
161 	default:
162 		if (pci_get_class(dev) == PCIC_SERIALBUS
163 		    && pci_get_subclass(dev) == PCIS_SERIALBUS_SMBUS
164 		    && pci_get_progif(dev) == PCIS_SERIALBUS_SMBUS_PROGIF) {
165 			device_set_desc(dev, "SMBus controller");
166 			return (BUS_PROBE_DEFAULT); /* XXX */
167 		}
168 		return (ENXIO);
169 	}
170 
171 	/* Done */
172 	return (ichsmb_probe(dev));
173 }
174 
175 static int
176 ichsmb_pci_attach(device_t dev)
177 {
178 	const sc_p sc = device_get_softc(dev);
179 	int error;
180 
181 	/* Initialize private state */
182 	bzero(sc, sizeof(*sc));
183 	sc->ich_cmd = -1;
184 	sc->dev = dev;
185 
186 	/* Allocate an I/O range */
187 	sc->io_rid = ICH_SMB_BASE;
188 	sc->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
189 	    &sc->io_rid, 0, ~0, 16, RF_ACTIVE);
190 	if (sc->io_res == NULL)
191 		sc->io_res = bus_alloc_resource(dev, SYS_RES_IOPORT,
192 		    &sc->io_rid, 0, ~0, 32, RF_ACTIVE);
193 	if (sc->io_res == NULL) {
194 		device_printf(dev, "can't map I/O\n");
195 		error = ENXIO;
196 		goto fail;
197 	}
198 	sc->io_bst = rman_get_bustag(sc->io_res);
199 	sc->io_bsh = rman_get_bushandle(sc->io_res);
200 
201 	/* Allocate interrupt */
202 	sc->irq_rid = 0;
203 	sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ,
204 	    &sc->irq_rid, RF_ACTIVE | RF_SHAREABLE);
205 	if (sc->irq_res == NULL) {
206 		device_printf(dev, "can't get IRQ\n");
207 		error = ENXIO;
208 		goto fail;
209 	}
210 
211 	/* Enable device */
212 	pci_write_config(dev, ICH_HOSTC, ICH_HOSTC_HST_EN, 1);
213 
214 	/* Done */
215 	error = ichsmb_attach(dev);
216 	if (error)
217 		goto fail;
218 	return (0);
219 
220 fail:
221 	/* Attach failed, release resources */
222 	ichsmb_release_resources(sc);
223 	return (error);
224 }
225 
226 
227 MODULE_DEPEND(ichsmb, pci, 1, 1, 1);
228 MODULE_DEPEND(ichsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
229 MODULE_VERSION(ichsmb, 1);
230