piixpm.c revision 1.23 1 /* $NetBSD: piixpm.c,v 1.23 2008/03/26 11:14:33 jmcneill Exp $ */
2 /* $OpenBSD: piixpm.c,v 1.20 2006/02/27 08:25:02 grange Exp $ */
3
4 /*
5 * Copyright (c) 2005, 2006 Alexander Yurchenko <grange (at) openbsd.org>
6 *
7 * Permission to use, copy, modify, and distribute this software for any
8 * purpose with or without fee is hereby granted, provided that the above
9 * copyright notice and this permission notice appear in all copies.
10 *
11 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
12 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
13 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
14 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
15 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
16 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
17 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
18 */
19
20 /*
21 * Intel PIIX and compatible Power Management controller driver.
22 */
23
24 #include <sys/cdefs.h>
25 __KERNEL_RCSID(0, "$NetBSD: piixpm.c,v 1.23 2008/03/26 11:14:33 jmcneill Exp $");
26
27 #include <sys/param.h>
28 #include <sys/systm.h>
29 #include <sys/device.h>
30 #include <sys/kernel.h>
31 #include <sys/rwlock.h>
32 #include <sys/proc.h>
33
34 #include <sys/bus.h>
35
36 #include <dev/pci/pcidevs.h>
37 #include <dev/pci/pcireg.h>
38 #include <dev/pci/pcivar.h>
39
40 #include <dev/pci/piixpmreg.h>
41
42 #include <dev/i2c/i2cvar.h>
43
44 #include <dev/ic/acpipmtimer.h>
45
46 #ifdef PIIXPM_DEBUG
47 #define DPRINTF(x) printf x
48 #else
49 #define DPRINTF(x)
50 #endif
51
52 #define PIIXPM_DELAY 200
53 #define PIIXPM_TIMEOUT 1
54
55 struct piixpm_softc {
56 struct device sc_dev;
57
58 bus_space_tag_t sc_smb_iot;
59 bus_space_handle_t sc_smb_ioh;
60 void * sc_smb_ih;
61 int sc_poll;
62
63 bus_space_tag_t sc_pm_iot;
64 bus_space_handle_t sc_pm_ioh;
65
66 pci_chipset_tag_t sc_pc;
67 pcitag_t sc_pcitag;
68
69 struct i2c_controller sc_i2c_tag;
70 krwlock_t sc_i2c_rwlock;
71 struct {
72 i2c_op_t op;
73 void * buf;
74 size_t len;
75 int flags;
76 volatile int error;
77 } sc_i2c_xfer;
78
79 pcireg_t sc_devact[2];
80 };
81
82 int piixpm_match(struct device *, struct cfdata *, void *);
83 void piixpm_attach(struct device *, struct device *, void *);
84
85 static bool piixpm_suspend(device_t PMF_FN_PROTO);
86 static bool piixpm_resume(device_t PMF_FN_PROTO);
87
88 int piixpm_i2c_acquire_bus(void *, int);
89 void piixpm_i2c_release_bus(void *, int);
90 int piixpm_i2c_exec(void *, i2c_op_t, i2c_addr_t, const void *, size_t,
91 void *, size_t, int);
92
93 int piixpm_intr(void *);
94
95 CFATTACH_DECL(piixpm, sizeof(struct piixpm_softc),
96 piixpm_match, piixpm_attach, NULL, NULL);
97
98 int
99 piixpm_match(struct device *parent, struct cfdata *match,
100 void *aux)
101 {
102 struct pci_attach_args *pa;
103
104 pa = (struct pci_attach_args *)aux;
105 switch (PCI_VENDOR(pa->pa_id)) {
106 case PCI_VENDOR_INTEL:
107 switch (PCI_PRODUCT(pa->pa_id)) {
108 case PCI_PRODUCT_INTEL_82371AB_PMC:
109 case PCI_PRODUCT_INTEL_82440MX_PMC:
110 return 1;
111 }
112 break;
113 case PCI_VENDOR_ATI:
114 switch (PCI_PRODUCT(pa->pa_id)) {
115 case PCI_PRODUCT_ATI_SB200_SMB:
116 case PCI_PRODUCT_ATI_SB300_SMB:
117 case PCI_PRODUCT_ATI_SB400_SMB:
118 case PCI_PRODUCT_ATI_SB600_SMB: /* matches SB600/SB700/SB800 */
119 return 1;
120 }
121 break;
122 case PCI_VENDOR_SERVERWORKS:
123 switch (PCI_PRODUCT(pa->pa_id)) {
124 case PCI_PRODUCT_SERVERWORKS_OSB4:
125 case PCI_PRODUCT_SERVERWORKS_CSB5:
126 case PCI_PRODUCT_SERVERWORKS_CSB6:
127 case PCI_PRODUCT_SERVERWORKS_HT1000SB:
128 return 1;
129 }
130 }
131
132 return 0;
133 }
134
135 void
136 piixpm_attach(struct device *parent, struct device *self, void *aux)
137 {
138 struct piixpm_softc *sc = (struct piixpm_softc *)self;
139 struct pci_attach_args *pa = aux;
140 struct i2cbus_attach_args iba;
141 pcireg_t base, conf;
142 pcireg_t pmmisc;
143 pci_intr_handle_t ih;
144 char devinfo[256];
145 const char *intrstr = NULL;
146
147 sc->sc_pc = pa->pa_pc;
148 sc->sc_pcitag = pa->pa_tag;
149
150 aprint_naive("\n");
151
152 pci_devinfo(pa->pa_id, pa->pa_class, 0, devinfo, sizeof(devinfo));
153 aprint_normal("\n%s: %s (rev. 0x%02x)\n",
154 device_xname(self), devinfo, PCI_REVISION(pa->pa_class));
155
156 if (!pmf_device_register(self, piixpm_suspend, piixpm_resume))
157 aprint_error_dev(self, "couldn't establish power handler\n");
158
159 /* Read configuration */
160 conf = pci_conf_read(pa->pa_pc, pa->pa_tag, PIIX_SMB_HOSTC);
161 DPRINTF(("%s: conf 0x%x\n", sc->sc_dev.dv_xname, conf));
162
163 if ((PCI_VENDOR(pa->pa_id) != PCI_VENDOR_INTEL) ||
164 (PCI_PRODUCT(pa->pa_id) != PCI_PRODUCT_INTEL_82371AB_PMC))
165 goto nopowermanagement;
166
167 /* check whether I/O access to PM regs is enabled */
168 pmmisc = pci_conf_read(pa->pa_pc, pa->pa_tag, PIIX_PMREGMISC);
169 if (!(pmmisc & 1))
170 goto nopowermanagement;
171
172 sc->sc_pm_iot = pa->pa_iot;
173 /* Map I/O space */
174 base = pci_conf_read(pa->pa_pc, pa->pa_tag, PIIX_PM_BASE);
175 if (bus_space_map(sc->sc_pm_iot, PCI_MAPREG_IO_ADDR(base),
176 PIIX_PM_SIZE, 0, &sc->sc_pm_ioh)) {
177 aprint_error("%s: can't map power management I/O space\n",
178 sc->sc_dev.dv_xname);
179 goto nopowermanagement;
180 }
181
182 /*
183 * Revision 0 and 1 are PIIX4, 2 is PIIX4E, 3 is PIIX4M.
184 * PIIX4 and PIIX4E have a bug in the timer latch, see Errata #20
185 * in the "Specification update" (document #297738).
186 */
187 acpipmtimer_attach(&sc->sc_dev, sc->sc_pm_iot, sc->sc_pm_ioh,
188 PIIX_PM_PMTMR,
189 (PCI_REVISION(pa->pa_class) < 3) ? ACPIPMT_BADLATCH : 0 );
190
191 nopowermanagement:
192 if ((conf & PIIX_SMB_HOSTC_HSTEN) == 0) {
193 aprint_normal("%s: SMBus disabled\n", sc->sc_dev.dv_xname);
194 return;
195 }
196
197 /* Map I/O space */
198 sc->sc_smb_iot = pa->pa_iot;
199 base = pci_conf_read(pa->pa_pc, pa->pa_tag, PIIX_SMB_BASE) & 0xffff;
200 if (bus_space_map(sc->sc_smb_iot, PCI_MAPREG_IO_ADDR(base),
201 PIIX_SMB_SIZE, 0, &sc->sc_smb_ioh)) {
202 aprint_error("%s: can't map smbus I/O space\n",
203 sc->sc_dev.dv_xname);
204 return;
205 }
206
207 sc->sc_poll = 1;
208 if ((conf & PIIX_SMB_HOSTC_INTMASK) == PIIX_SMB_HOSTC_SMI) {
209 /* No PCI IRQ */
210 aprint_normal("%s: interrupting at SMI", sc->sc_dev.dv_xname);
211 } else if ((conf & PIIX_SMB_HOSTC_INTMASK) == PIIX_SMB_HOSTC_IRQ) {
212 /* Install interrupt handler */
213 if (pci_intr_map(pa, &ih) == 0) {
214 intrstr = pci_intr_string(pa->pa_pc, ih);
215 sc->sc_smb_ih = pci_intr_establish(pa->pa_pc, ih, IPL_BIO,
216 piixpm_intr, sc);
217 if (sc->sc_smb_ih != NULL) {
218 aprint_normal("%s: interrupting at %s",
219 sc->sc_dev.dv_xname, intrstr);
220 sc->sc_poll = 0;
221 }
222 }
223 if (sc->sc_poll)
224 aprint_normal("%s: polling", sc->sc_dev.dv_xname);
225 }
226
227 aprint_normal("\n");
228
229 /* Attach I2C bus */
230 rw_init(&sc->sc_i2c_rwlock);
231 sc->sc_i2c_tag.ic_cookie = sc;
232 sc->sc_i2c_tag.ic_acquire_bus = piixpm_i2c_acquire_bus;
233 sc->sc_i2c_tag.ic_release_bus = piixpm_i2c_release_bus;
234 sc->sc_i2c_tag.ic_exec = piixpm_i2c_exec;
235
236 bzero(&iba, sizeof(iba));
237 iba.iba_tag = &sc->sc_i2c_tag;
238 config_found_ia(self, "i2cbus", &iba, iicbus_print);
239
240 return;
241 }
242
243 static bool
244 piixpm_suspend(device_t dv PMF_FN_ARGS)
245 {
246 struct piixpm_softc *sc = device_private(dv);
247
248 sc->sc_devact[0] = pci_conf_read(sc->sc_pc, sc->sc_pcitag,
249 PIIX_DEVACTA);
250 sc->sc_devact[1] = pci_conf_read(sc->sc_pc, sc->sc_pcitag,
251 PIIX_DEVACTB);
252
253 return true;
254 }
255
256 static bool
257 piixpm_resume(device_t dv PMF_FN_ARGS)
258 {
259 struct piixpm_softc *sc = device_private(dv);
260
261 pci_conf_write(sc->sc_pc, sc->sc_pcitag, PIIX_DEVACTA,
262 sc->sc_devact[0]);
263 pci_conf_write(sc->sc_pc, sc->sc_pcitag, PIIX_DEVACTB,
264 sc->sc_devact[1]);
265
266 return true;
267 }
268
269 int
270 piixpm_i2c_acquire_bus(void *cookie, int flags)
271 {
272 struct piixpm_softc *sc = cookie;
273
274 if (cold || sc->sc_poll || (flags & I2C_F_POLL))
275 return (0);
276
277 rw_enter(&sc->sc_i2c_rwlock, RW_WRITER);
278 return 0;
279 }
280
281 void
282 piixpm_i2c_release_bus(void *cookie, int flags)
283 {
284 struct piixpm_softc *sc = cookie;
285
286 if (cold || sc->sc_poll || (flags & I2C_F_POLL))
287 return;
288
289 rw_exit(&sc->sc_i2c_rwlock);
290 }
291
292 int
293 piixpm_i2c_exec(void *cookie, i2c_op_t op, i2c_addr_t addr,
294 const void *cmdbuf, size_t cmdlen, void *buf, size_t len, int flags)
295 {
296 struct piixpm_softc *sc = cookie;
297 const u_int8_t *b;
298 u_int8_t ctl = 0, st;
299 int retries;
300
301 DPRINTF(("%s: exec: op %d, addr 0x%x, cmdlen %d, len %d, flags 0x%x\n",
302 sc->sc_dev.dv_xname, op, addr, cmdlen, len, flags));
303
304 /* Wait for bus to be idle */
305 for (retries = 100; retries > 0; retries--) {
306 st = bus_space_read_1(sc->sc_smb_iot, sc->sc_smb_ioh,
307 PIIX_SMB_HS);
308 if (!(st & PIIX_SMB_HS_BUSY))
309 break;
310 DELAY(PIIXPM_DELAY);
311 }
312 DPRINTF(("%s: exec: st 0x%d\n", sc->sc_dev.dv_xname, st & 0xff));
313 if (st & PIIX_SMB_HS_BUSY)
314 return (1);
315
316 if (cold || sc->sc_poll)
317 flags |= I2C_F_POLL;
318
319 if (!I2C_OP_STOP_P(op) || cmdlen > 1 || len > 2)
320 return (1);
321
322 /* Setup transfer */
323 sc->sc_i2c_xfer.op = op;
324 sc->sc_i2c_xfer.buf = buf;
325 sc->sc_i2c_xfer.len = len;
326 sc->sc_i2c_xfer.flags = flags;
327 sc->sc_i2c_xfer.error = 0;
328
329 /* Set slave address and transfer direction */
330 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_TXSLVA,
331 PIIX_SMB_TXSLVA_ADDR(addr) |
332 (I2C_OP_READ_P(op) ? PIIX_SMB_TXSLVA_READ : 0));
333
334 b = cmdbuf;
335 if (cmdlen > 0)
336 /* Set command byte */
337 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh,
338 PIIX_SMB_HCMD, b[0]);
339
340 if (I2C_OP_WRITE_P(op)) {
341 /* Write data */
342 b = buf;
343 if (len > 0)
344 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh,
345 PIIX_SMB_HD0, b[0]);
346 if (len > 1)
347 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh,
348 PIIX_SMB_HD1, b[1]);
349 }
350
351 /* Set SMBus command */
352 if (len == 0)
353 ctl = PIIX_SMB_HC_CMD_BYTE;
354 else if (len == 1)
355 ctl = PIIX_SMB_HC_CMD_BDATA;
356 else if (len == 2)
357 ctl = PIIX_SMB_HC_CMD_WDATA;
358
359 if ((flags & I2C_F_POLL) == 0)
360 ctl |= PIIX_SMB_HC_INTREN;
361
362 /* Start transaction */
363 ctl |= PIIX_SMB_HC_START;
364 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_HC, ctl);
365
366 if (flags & I2C_F_POLL) {
367 /* Poll for completion */
368 DELAY(PIIXPM_DELAY);
369 for (retries = 1000; retries > 0; retries--) {
370 st = bus_space_read_1(sc->sc_smb_iot, sc->sc_smb_ioh,
371 PIIX_SMB_HS);
372 if ((st & PIIX_SMB_HS_BUSY) == 0)
373 break;
374 DELAY(PIIXPM_DELAY);
375 }
376 if (st & PIIX_SMB_HS_BUSY)
377 goto timeout;
378 piixpm_intr(sc);
379 } else {
380 /* Wait for interrupt */
381 if (tsleep(sc, PRIBIO, "iicexec", PIIXPM_TIMEOUT * hz))
382 goto timeout;
383 }
384
385 if (sc->sc_i2c_xfer.error)
386 return (1);
387
388 return (0);
389
390 timeout:
391 /*
392 * Transfer timeout. Kill the transaction and clear status bits.
393 */
394 aprint_error("%s: timeout, status 0x%x\n", sc->sc_dev.dv_xname, st);
395 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_HC,
396 PIIX_SMB_HC_KILL);
397 DELAY(PIIXPM_DELAY);
398 st = bus_space_read_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_HS);
399 if ((st & PIIX_SMB_HS_FAILED) == 0)
400 aprint_error("%s: transaction abort failed, status 0x%x\n",
401 sc->sc_dev.dv_xname, st);
402 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_HS, st);
403 return (1);
404 }
405
406 int
407 piixpm_intr(void *arg)
408 {
409 struct piixpm_softc *sc = arg;
410 u_int8_t st;
411 u_int8_t *b;
412 size_t len;
413
414 /* Read status */
415 st = bus_space_read_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_HS);
416 if ((st & PIIX_SMB_HS_BUSY) != 0 || (st & (PIIX_SMB_HS_INTR |
417 PIIX_SMB_HS_DEVERR | PIIX_SMB_HS_BUSERR |
418 PIIX_SMB_HS_FAILED)) == 0)
419 /* Interrupt was not for us */
420 return (0);
421
422 DPRINTF(("%s: intr st 0x%d\n", sc->sc_dev.dv_xname, st & 0xff));
423
424 /* Clear status bits */
425 bus_space_write_1(sc->sc_smb_iot, sc->sc_smb_ioh, PIIX_SMB_HS, st);
426
427 /* Check for errors */
428 if (st & (PIIX_SMB_HS_DEVERR | PIIX_SMB_HS_BUSERR |
429 PIIX_SMB_HS_FAILED)) {
430 sc->sc_i2c_xfer.error = 1;
431 goto done;
432 }
433
434 if (st & PIIX_SMB_HS_INTR) {
435 if (I2C_OP_WRITE_P(sc->sc_i2c_xfer.op))
436 goto done;
437
438 /* Read data */
439 b = sc->sc_i2c_xfer.buf;
440 len = sc->sc_i2c_xfer.len;
441 if (len > 0)
442 b[0] = bus_space_read_1(sc->sc_smb_iot, sc->sc_smb_ioh,
443 PIIX_SMB_HD0);
444 if (len > 1)
445 b[1] = bus_space_read_1(sc->sc_smb_iot, sc->sc_smb_ioh,
446 PIIX_SMB_HD1);
447 }
448
449 done:
450 if ((sc->sc_i2c_xfer.flags & I2C_F_POLL) == 0)
451 wakeup(sc);
452 return (1);
453 }
454