2 * Copyright (c) 1998, 1999 Takanori Watanabe
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
30 #include <sys/param.h>
31 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/module.h>
36 #include <sys/mutex.h>
38 #include <machine/bus.h>
39 #include <dev/smbus/smbconf.h>
43 #include <dev/pci/pcireg.h>
44 #include <dev/pci/pcivar.h>
45 #include <pci/intpmreg.h>
47 #include "opt_intpm.h"
51 struct resource *io_res;
52 struct resource *irq_res;
59 #define INTSMB_LOCK(sc) mtx_lock(&(sc)->lock)
60 #define INTSMB_UNLOCK(sc) mtx_unlock(&(sc)->lock)
61 #define INTSMB_LOCK_ASSERT(sc) mtx_assert(&(sc)->lock, MA_OWNED)
63 static int intsmb_probe(device_t);
64 static int intsmb_attach(device_t);
65 static int intsmb_detach(device_t);
66 static int intsmb_intr(struct intsmb_softc *sc);
67 static int intsmb_slvintr(struct intsmb_softc *sc);
68 static void intsmb_alrintr(struct intsmb_softc *sc);
69 static int intsmb_callback(device_t dev, int index, void *data);
70 static int intsmb_quick(device_t dev, u_char slave, int how);
71 static int intsmb_sendb(device_t dev, u_char slave, char byte);
72 static int intsmb_recvb(device_t dev, u_char slave, char *byte);
73 static int intsmb_writeb(device_t dev, u_char slave, char cmd, char byte);
74 static int intsmb_writew(device_t dev, u_char slave, char cmd, short word);
75 static int intsmb_readb(device_t dev, u_char slave, char cmd, char *byte);
76 static int intsmb_readw(device_t dev, u_char slave, char cmd, short *word);
77 static int intsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata);
78 static int intsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf);
79 static int intsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf);
80 static void intsmb_start(struct intsmb_softc *sc, u_char cmd, int nointr);
81 static int intsmb_stop(struct intsmb_softc *sc);
82 static int intsmb_stop_poll(struct intsmb_softc *sc);
83 static int intsmb_free(struct intsmb_softc *sc);
84 static void intsmb_rawintr(void *arg);
87 intsmb_probe(device_t dev)
90 switch (pci_get_devid(dev)) {
91 case 0x71138086: /* Intel 82371AB */
92 case 0x719b8086: /* Intel 82443MX */
94 /* Not a good idea yet, this stops isab0 functioning */
95 case 0x02001166: /* ServerWorks OSB4 */
97 device_set_desc(dev, "Intel PIIX4 SMBUS Interface");
103 return (BUS_PROBE_DEFAULT);
107 intsmb_attach(device_t dev)
109 struct intsmb_softc *sc = device_get_softc(dev);
110 int error, rid, value;
115 mtx_init(&sc->lock, device_get_nameunit(dev), "intsmb", MTX_DEF);
117 rid = PCI_BASE_ADDR_SMB;
118 sc->io_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
120 if (sc->io_res == NULL) {
121 device_printf(dev, "Could not allocate I/O space\n");
126 #ifndef NO_CHANGE_PCICONF
127 pci_write_config(dev, PCIR_INTLINE, 0x9, 1);
128 pci_write_config(dev, PCI_HST_CFG_SMB,
129 PCI_INTR_SMB_IRQ9 | PCI_INTR_SMB_ENABLE, 1);
131 value = pci_read_config(dev, PCI_HST_CFG_SMB, 1);
132 switch (value & 0xe) {
133 case PCI_INTR_SMB_SMI:
136 case PCI_INTR_SMB_IRQ9:
142 device_printf(dev, "intr %s %s ", str,
143 (value & 1) ? "enabled" : "disabled");
144 printf("revision %d\n", pci_read_config(dev, PCI_REVID_SMB, 1));
146 if ((value & 0xe) != PCI_INTR_SMB_IRQ9) {
147 device_printf(dev, "Unsupported interrupt mode\n");
154 bus_set_resource(dev, SYS_RES_IRQ, rid, 9, 1);
155 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
156 RF_SHAREABLE | RF_ACTIVE);
157 if (sc->irq_res == NULL) {
158 device_printf(dev, "Could not allocate irq\n");
163 error = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
164 NULL, intsmb_rawintr, sc, &sc->irq_hand);
166 device_printf(dev, "Failed to map intr\n");
171 sc->smbus = device_add_child(dev, "smbus", -1);
172 if (sc->smbus == NULL) {
176 error = device_probe_and_attach(sc->smbus);
182 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT, PIIX4_SMBSLVCNT_ALTEN);
192 intsmb_detach(device_t dev)
194 struct intsmb_softc *sc = device_get_softc(dev);
197 error = bus_generic_detach(dev);
202 device_delete_child(dev, sc->smbus);
204 bus_teardown_intr(dev, sc->irq_res, sc->irq_hand);
206 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
208 bus_release_resource(dev, SYS_RES_IOPORT, PCI_BASE_ADDR_SMB,
210 mtx_destroy(&sc->lock);
215 intsmb_rawintr(void *arg)
217 struct intsmb_softc *sc = arg;
226 intsmb_callback(device_t dev, int index, void *data)
231 case SMB_REQUEST_BUS:
233 case SMB_RELEASE_BUS:
242 /* Counterpart of smbtx_smb_free(). */
244 intsmb_free(struct intsmb_softc *sc)
247 INTSMB_LOCK_ASSERT(sc);
248 if ((bus_read_1(sc->io_res, PIIX4_SMBHSTSTS) & PIIX4_SMBHSTSTAT_BUSY) ||
250 (bus_read_1(sc->io_res, PIIX4_SMBSLVSTS) & PIIX4_SMBSLVSTS_BUSY) ||
256 /* Disable Interrupt in slave part. */
258 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT, 0);
260 /* Reset INTR Flag to prepare INTR. */
261 bus_write_1(sc->io_res, PIIX4_SMBHSTSTS,
262 PIIX4_SMBHSTSTAT_INTR | PIIX4_SMBHSTSTAT_ERR |
263 PIIX4_SMBHSTSTAT_BUSC | PIIX4_SMBHSTSTAT_FAIL);
268 intsmb_intr(struct intsmb_softc *sc)
272 status = bus_read_1(sc->io_res, PIIX4_SMBHSTSTS);
273 if (status & PIIX4_SMBHSTSTAT_BUSY)
276 if (status & (PIIX4_SMBHSTSTAT_INTR | PIIX4_SMBHSTSTAT_ERR |
277 PIIX4_SMBHSTSTAT_BUSC | PIIX4_SMBHSTSTAT_FAIL)) {
279 tmp = bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
280 bus_write_1(sc->io_res, PIIX4_SMBHSTCNT,
281 tmp & ~PIIX4_SMBHSTCNT_INTREN);
288 return (1); /* Not Completed */
292 intsmb_slvintr(struct intsmb_softc *sc)
296 status = bus_read_1(sc->io_res, PIIX4_SMBSLVSTS);
297 if (status & PIIX4_SMBSLVSTS_BUSY)
299 if (status & PIIX4_SMBSLVSTS_ALART)
301 else if (status & ~(PIIX4_SMBSLVSTS_ALART | PIIX4_SMBSLVSTS_SDW2
302 | PIIX4_SMBSLVSTS_SDW1)) {
305 /* Reset Status Register */
306 bus_write_1(sc->io_res, PIIX4_SMBSLVSTS,
307 PIIX4_SMBSLVSTS_ALART | PIIX4_SMBSLVSTS_SDW2 |
308 PIIX4_SMBSLVSTS_SDW1 | PIIX4_SMBSLVSTS_SLV);
313 intsmb_alrintr(struct intsmb_softc *sc)
321 /* Stop generating INTR from ALART. */
322 slvcnt = bus_read_1(sc->io_res, PIIX4_SMBSLVCNT);
324 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT,
325 slvcnt & ~PIIX4_SMBSLVCNT_ALTEN);
329 /* Ask bus who asserted it and then ask it what's the matter. */
331 error = intsmb_free(sc);
335 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, SMBALTRESP | LSB);
336 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BYTE, 1);
337 error = intsmb_stop_poll(sc);
339 device_printf(sc->dev, "ALART: ERROR\n");
341 addr = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
342 device_printf(sc->dev, "ALART_RESPONSE: 0x%x\n", addr);
345 /* Re-enable INTR from ALART. */
346 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT,
347 slvcnt | PIIX4_SMBSLVCNT_ALTEN);
353 intsmb_start(struct intsmb_softc *sc, unsigned char cmd, int nointr)
357 INTSMB_LOCK_ASSERT(sc);
358 tmp = bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
361 tmp |= PIIX4_SMBHSTCNT_START;
363 /* While not in autoconfiguration enable interrupts. */
364 if (!cold && !nointr)
365 tmp |= PIIX4_SMBHSTCNT_INTREN;
366 bus_write_1(sc->io_res, PIIX4_SMBHSTCNT, tmp);
370 intsmb_error(device_t dev, int status)
374 if (status & PIIX4_SMBHSTSTAT_ERR)
375 error |= SMB_EBUSERR;
376 if (status & PIIX4_SMBHSTSTAT_BUSC)
378 if (status & PIIX4_SMBHSTSTAT_FAIL)
381 if (error != 0 && bootverbose)
382 device_printf(dev, "error = %d, status = %#x\n", error, status);
390 * Polling is not encouraged because it requires waiting for the
391 * device if it is busy.
392 * (29063505.pdf from Intel) But during boot, interrupt cannot be used, so use
396 intsmb_stop_poll(struct intsmb_softc *sc)
398 int error, i, status, tmp;
400 INTSMB_LOCK_ASSERT(sc);
402 /* First, wait for busy to be set. */
403 for (i = 0; i < 0x7fff; i++)
404 if (bus_read_1(sc->io_res, PIIX4_SMBHSTSTS) &
405 PIIX4_SMBHSTSTAT_BUSY)
408 /* Wait for busy to clear. */
409 for (i = 0; i < 0x7fff; i++) {
410 status = bus_read_1(sc->io_res, PIIX4_SMBHSTSTS);
411 if (!(status & PIIX4_SMBHSTSTAT_BUSY)) {
413 error = intsmb_error(sc->dev, status);
414 if (error == 0 && !(status & PIIX4_SMBHSTSTAT_INTR))
415 device_printf(sc->dev, "unknown cause why?\n");
420 /* Timed out waiting for busy to clear. */
422 tmp = bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
423 bus_write_1(sc->io_res, PIIX4_SMBHSTCNT, tmp & ~PIIX4_SMBHSTCNT_INTREN);
424 return (SMB_ETIMEOUT);
428 * Wait for completion and return result.
431 intsmb_stop(struct intsmb_softc *sc)
435 INTSMB_LOCK_ASSERT(sc);
438 /* So that it can use device during device probe on SMBus. */
439 return (intsmb_stop_poll(sc));
441 error = msleep(sc, &sc->lock, PWAIT | PCATCH, "SMBWAI", hz / 8);
443 status = bus_read_1(sc->io_res, PIIX4_SMBHSTSTS);
444 if (!(status & PIIX4_SMBHSTSTAT_BUSY)) {
445 error = intsmb_error(sc->dev, status);
446 if (error == 0 && !(status & PIIX4_SMBHSTSTAT_INTR))
447 device_printf(sc->dev, "unknown cause why?\n");
449 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT,
450 PIIX4_SMBSLVCNT_ALTEN);
456 /* Timeout Procedure. */
459 /* Re-enable supressed interrupt from slave part. */
460 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT, PIIX4_SMBSLVCNT_ALTEN);
461 if (error == EWOULDBLOCK)
462 return (SMB_ETIMEOUT);
468 intsmb_quick(device_t dev, u_char slave, int how)
470 struct intsmb_softc *sc = device_get_softc(dev);
476 /* Quick command is part of Address, I think. */
489 error = intsmb_free(sc);
494 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, data);
495 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_QUICK, 0);
496 error = intsmb_stop(sc);
502 intsmb_sendb(device_t dev, u_char slave, char byte)
504 struct intsmb_softc *sc = device_get_softc(dev);
508 error = intsmb_free(sc);
513 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
514 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, byte);
515 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BYTE, 0);
516 error = intsmb_stop(sc);
522 intsmb_recvb(device_t dev, u_char slave, char *byte)
524 struct intsmb_softc *sc = device_get_softc(dev);
528 error = intsmb_free(sc);
533 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
534 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BYTE, 0);
535 error = intsmb_stop(sc);
537 #ifdef RECV_IS_IN_CMD
539 * Linux SMBus stuff also troubles
540 * Because Intel's datasheet does not make clear.
542 *byte = bus_read_1(sc->io_res, PIIX4_SMBHSTCMD);
544 *byte = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
552 intsmb_writeb(device_t dev, u_char slave, char cmd, char byte)
554 struct intsmb_softc *sc = device_get_softc(dev);
558 error = intsmb_free(sc);
563 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
564 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
565 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, byte);
566 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BDATA, 0);
567 error = intsmb_stop(sc);
573 intsmb_writew(device_t dev, u_char slave, char cmd, short word)
575 struct intsmb_softc *sc = device_get_softc(dev);
579 error = intsmb_free(sc);
584 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
585 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
586 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, word & 0xff);
587 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT1, (word >> 8) & 0xff);
588 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_WDATA, 0);
589 error = intsmb_stop(sc);
595 intsmb_readb(device_t dev, u_char slave, char cmd, char *byte)
597 struct intsmb_softc *sc = device_get_softc(dev);
601 error = intsmb_free(sc);
606 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
607 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
608 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BDATA, 0);
609 error = intsmb_stop(sc);
611 *byte = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
617 intsmb_readw(device_t dev, u_char slave, char cmd, short *word)
619 struct intsmb_softc *sc = device_get_softc(dev);
623 error = intsmb_free(sc);
628 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
629 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
630 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_WDATA, 0);
631 error = intsmb_stop(sc);
633 *word = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
634 *word |= bus_read_1(sc->io_res, PIIX4_SMBHSTDAT1) << 8;
641 * Data sheet claims that it implements all function, but also claims
642 * that it implements 7 function and not mention PCALL. So I don't know
643 * whether it will work.
646 intsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata)
649 struct intsmb_softc *sc = device_get_softc(dev);
653 error = intsmb_free(sc);
658 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
659 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
660 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, sdata & 0xff);
661 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT1, (sdata & 0xff) >> 8);
662 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_WDATA, 0);
663 error = intsmb_stop(sc);
665 *rdata = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
666 *rdata |= bus_read_1(sc->io_res, PIIX4_SMBHSTDAT1) << 8;
671 return (SMB_ENOTSUPP);
676 intsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf)
678 struct intsmb_softc *sc = device_get_softc(dev);
681 if (count > SMBBLOCKTRANS_MAX || count == 0)
685 error = intsmb_free(sc);
691 /* Reset internal array index. */
692 bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
694 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
695 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
696 for (i = 0; i < count; i++)
697 bus_write_1(sc->io_res, PIIX4_SMBBLKDAT, buf[i]);
698 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, count);
699 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BLOCK, 0);
700 error = intsmb_stop(sc);
706 intsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf)
708 struct intsmb_softc *sc = device_get_softc(dev);
712 if (*count > SMBBLOCKTRANS_MAX || *count == 0)
716 error = intsmb_free(sc);
722 /* Reset internal array index. */
723 bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
725 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
726 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
727 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, *count);
728 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BLOCK, 0);
729 error = intsmb_stop(sc);
731 nread = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
732 if (nread != 0 && nread <= SMBBLOCKTRANS_MAX) {
733 for (i = 0; i < nread; i++) {
734 data = bus_read_1(sc->io_res, PIIX4_SMBBLKDAT);
746 static devclass_t intsmb_devclass;
748 static device_method_t intsmb_methods[] = {
749 /* Device interface */
750 DEVMETHOD(device_probe, intsmb_probe),
751 DEVMETHOD(device_attach, intsmb_attach),
752 DEVMETHOD(device_detach, intsmb_detach),
755 DEVMETHOD(bus_print_child, bus_generic_print_child),
757 /* SMBus interface */
758 DEVMETHOD(smbus_callback, intsmb_callback),
759 DEVMETHOD(smbus_quick, intsmb_quick),
760 DEVMETHOD(smbus_sendb, intsmb_sendb),
761 DEVMETHOD(smbus_recvb, intsmb_recvb),
762 DEVMETHOD(smbus_writeb, intsmb_writeb),
763 DEVMETHOD(smbus_writew, intsmb_writew),
764 DEVMETHOD(smbus_readb, intsmb_readb),
765 DEVMETHOD(smbus_readw, intsmb_readw),
766 DEVMETHOD(smbus_pcall, intsmb_pcall),
767 DEVMETHOD(smbus_bwrite, intsmb_bwrite),
768 DEVMETHOD(smbus_bread, intsmb_bread),
773 static driver_t intsmb_driver = {
776 sizeof(struct intsmb_softc),
779 DRIVER_MODULE(intsmb, pci, intsmb_driver, intsmb_devclass, 0, 0);
780 DRIVER_MODULE(smbus, intsmb, smbus_driver, smbus_devclass, 0, 0);
781 MODULE_DEPEND(intsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
782 MODULE_VERSION(intsmb, 1);