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;
61 #define INTSMB_LOCK(sc) mtx_lock(&(sc)->lock)
62 #define INTSMB_UNLOCK(sc) mtx_unlock(&(sc)->lock)
63 #define INTSMB_LOCK_ASSERT(sc) mtx_assert(&(sc)->lock, MA_OWNED)
65 static int intsmb_probe(device_t);
66 static int intsmb_attach(device_t);
67 static int intsmb_detach(device_t);
68 static int intsmb_intr(struct intsmb_softc *sc);
69 static int intsmb_slvintr(struct intsmb_softc *sc);
70 static void intsmb_alrintr(struct intsmb_softc *sc);
71 static int intsmb_callback(device_t dev, int index, void *data);
72 static int intsmb_quick(device_t dev, u_char slave, int how);
73 static int intsmb_sendb(device_t dev, u_char slave, char byte);
74 static int intsmb_recvb(device_t dev, u_char slave, char *byte);
75 static int intsmb_writeb(device_t dev, u_char slave, char cmd, char byte);
76 static int intsmb_writew(device_t dev, u_char slave, char cmd, short word);
77 static int intsmb_readb(device_t dev, u_char slave, char cmd, char *byte);
78 static int intsmb_readw(device_t dev, u_char slave, char cmd, short *word);
79 static int intsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata);
80 static int intsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf);
81 static int intsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf);
82 static void intsmb_start(struct intsmb_softc *sc, u_char cmd, int nointr);
83 static int intsmb_stop(struct intsmb_softc *sc);
84 static int intsmb_stop_poll(struct intsmb_softc *sc);
85 static int intsmb_free(struct intsmb_softc *sc);
86 static void intsmb_rawintr(void *arg);
89 intsmb_probe(device_t dev)
92 switch (pci_get_devid(dev)) {
93 case 0x71138086: /* Intel 82371AB */
94 case 0x719b8086: /* Intel 82443MX */
96 /* Not a good idea yet, this stops isab0 functioning */
97 case 0x02001166: /* ServerWorks OSB4 */
99 device_set_desc(dev, "Intel PIIX4 SMBUS Interface");
102 device_set_desc(dev, "ATI IXP400 SMBus Controller");
105 /* SB800 and newer can not be configured in a compatible way. */
106 if (pci_get_revid(dev) >= 0x40)
108 device_set_desc(dev, "AMD SB600/700/710/750 SMBus Controller");
109 /* XXX Maybe force polling right here? */
115 return (BUS_PROBE_DEFAULT);
119 intsmb_attach(device_t dev)
121 struct intsmb_softc *sc = device_get_softc(dev);
122 int error, rid, value;
128 mtx_init(&sc->lock, device_get_nameunit(dev), "intsmb", MTX_DEF);
131 #ifndef NO_CHANGE_PCICONF
132 switch (pci_get_devid(dev)) {
133 case 0x71138086: /* Intel 82371AB */
134 case 0x719b8086: /* Intel 82443MX */
135 /* Changing configuration is allowed. */
141 rid = PCI_BASE_ADDR_SMB;
142 sc->io_res = bus_alloc_resource_any(dev, SYS_RES_IOPORT, &rid,
144 if (sc->io_res == NULL) {
145 device_printf(dev, "Could not allocate I/O space\n");
151 pci_write_config(dev, PCIR_INTLINE, 0x9, 1);
152 pci_write_config(dev, PCI_HST_CFG_SMB,
153 PCI_INTR_SMB_IRQ9 | PCI_INTR_SMB_ENABLE, 1);
155 value = pci_read_config(dev, PCI_HST_CFG_SMB, 1);
156 sc->poll = (value & PCI_INTR_SMB_ENABLE) == 0;
157 intr = value & PCI_INTR_SMB_MASK;
159 case PCI_INTR_SMB_SMI:
162 case PCI_INTR_SMB_IRQ9:
165 case PCI_INTR_SMB_IRQ_PCI:
172 device_printf(dev, "intr %s %s ", str,
173 sc->poll == 0 ? "enabled" : "disabled");
174 printf("revision %d\n", pci_read_config(dev, PCI_REVID_SMB, 1));
176 if (!sc->poll && intr == PCI_INTR_SMB_SMI) {
178 "using polling mode when configured interrupt is SMI\n");
185 if (intr != PCI_INTR_SMB_IRQ9 && intr != PCI_INTR_SMB_IRQ_PCI) {
186 device_printf(dev, "Unsupported interrupt mode\n");
194 bus_set_resource(dev, SYS_RES_IRQ, rid, 9, 1);
196 sc->irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
197 RF_SHAREABLE | RF_ACTIVE);
198 if (sc->irq_res == NULL) {
199 device_printf(dev, "Could not allocate irq\n");
204 error = bus_setup_intr(dev, sc->irq_res, INTR_TYPE_MISC | INTR_MPSAFE,
205 NULL, intsmb_rawintr, sc, &sc->irq_hand);
207 device_printf(dev, "Failed to map intr\n");
213 sc->smbus = device_add_child(dev, "smbus", -1);
214 if (sc->smbus == NULL) {
218 error = device_probe_and_attach(sc->smbus);
224 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT, PIIX4_SMBSLVCNT_ALTEN);
234 intsmb_detach(device_t dev)
236 struct intsmb_softc *sc = device_get_softc(dev);
239 error = bus_generic_detach(dev);
244 device_delete_child(dev, sc->smbus);
246 bus_teardown_intr(dev, sc->irq_res, sc->irq_hand);
248 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->irq_res);
250 bus_release_resource(dev, SYS_RES_IOPORT, PCI_BASE_ADDR_SMB,
252 mtx_destroy(&sc->lock);
257 intsmb_rawintr(void *arg)
259 struct intsmb_softc *sc = arg;
268 intsmb_callback(device_t dev, int index, void *data)
273 case SMB_REQUEST_BUS:
275 case SMB_RELEASE_BUS:
284 /* Counterpart of smbtx_smb_free(). */
286 intsmb_free(struct intsmb_softc *sc)
289 INTSMB_LOCK_ASSERT(sc);
290 if ((bus_read_1(sc->io_res, PIIX4_SMBHSTSTS) & PIIX4_SMBHSTSTAT_BUSY) ||
292 (bus_read_1(sc->io_res, PIIX4_SMBSLVSTS) & PIIX4_SMBSLVSTS_BUSY) ||
298 /* Disable Interrupt in slave part. */
300 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT, 0);
302 /* Reset INTR Flag to prepare INTR. */
303 bus_write_1(sc->io_res, PIIX4_SMBHSTSTS,
304 PIIX4_SMBHSTSTAT_INTR | PIIX4_SMBHSTSTAT_ERR |
305 PIIX4_SMBHSTSTAT_BUSC | PIIX4_SMBHSTSTAT_FAIL);
310 intsmb_intr(struct intsmb_softc *sc)
314 status = bus_read_1(sc->io_res, PIIX4_SMBHSTSTS);
315 if (status & PIIX4_SMBHSTSTAT_BUSY)
318 if (status & (PIIX4_SMBHSTSTAT_INTR | PIIX4_SMBHSTSTAT_ERR |
319 PIIX4_SMBHSTSTAT_BUSC | PIIX4_SMBHSTSTAT_FAIL)) {
321 tmp = bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
322 bus_write_1(sc->io_res, PIIX4_SMBHSTCNT,
323 tmp & ~PIIX4_SMBHSTCNT_INTREN);
330 return (1); /* Not Completed */
334 intsmb_slvintr(struct intsmb_softc *sc)
338 status = bus_read_1(sc->io_res, PIIX4_SMBSLVSTS);
339 if (status & PIIX4_SMBSLVSTS_BUSY)
341 if (status & PIIX4_SMBSLVSTS_ALART)
343 else if (status & ~(PIIX4_SMBSLVSTS_ALART | PIIX4_SMBSLVSTS_SDW2
344 | PIIX4_SMBSLVSTS_SDW1)) {
347 /* Reset Status Register */
348 bus_write_1(sc->io_res, PIIX4_SMBSLVSTS,
349 PIIX4_SMBSLVSTS_ALART | PIIX4_SMBSLVSTS_SDW2 |
350 PIIX4_SMBSLVSTS_SDW1 | PIIX4_SMBSLVSTS_SLV);
355 intsmb_alrintr(struct intsmb_softc *sc)
363 /* Stop generating INTR from ALART. */
364 slvcnt = bus_read_1(sc->io_res, PIIX4_SMBSLVCNT);
366 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT,
367 slvcnt & ~PIIX4_SMBSLVCNT_ALTEN);
371 /* Ask bus who asserted it and then ask it what's the matter. */
373 error = intsmb_free(sc);
377 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, SMBALTRESP | LSB);
378 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BYTE, 1);
379 error = intsmb_stop_poll(sc);
381 device_printf(sc->dev, "ALART: ERROR\n");
383 addr = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
384 device_printf(sc->dev, "ALART_RESPONSE: 0x%x\n", addr);
387 /* Re-enable INTR from ALART. */
388 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT,
389 slvcnt | PIIX4_SMBSLVCNT_ALTEN);
395 intsmb_start(struct intsmb_softc *sc, unsigned char cmd, int nointr)
399 INTSMB_LOCK_ASSERT(sc);
400 tmp = bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
403 tmp |= PIIX4_SMBHSTCNT_START;
405 /* While not in autoconfiguration enable interrupts. */
406 if (!sc->poll && !cold && !nointr)
407 tmp |= PIIX4_SMBHSTCNT_INTREN;
408 bus_write_1(sc->io_res, PIIX4_SMBHSTCNT, tmp);
412 intsmb_error(device_t dev, int status)
416 if (status & PIIX4_SMBHSTSTAT_ERR)
417 error |= SMB_EBUSERR;
418 if (status & PIIX4_SMBHSTSTAT_BUSC)
420 if (status & PIIX4_SMBHSTSTAT_FAIL)
423 if (error != 0 && bootverbose)
424 device_printf(dev, "error = %d, status = %#x\n", error, status);
432 * Polling is not encouraged because it requires waiting for the
433 * device if it is busy.
434 * (29063505.pdf from Intel) But during boot, interrupt cannot be used, so use
438 intsmb_stop_poll(struct intsmb_softc *sc)
440 int error, i, status, tmp;
442 INTSMB_LOCK_ASSERT(sc);
444 /* First, wait for busy to be set. */
445 for (i = 0; i < 0x7fff; i++)
446 if (bus_read_1(sc->io_res, PIIX4_SMBHSTSTS) &
447 PIIX4_SMBHSTSTAT_BUSY)
450 /* Wait for busy to clear. */
451 for (i = 0; i < 0x7fff; i++) {
452 status = bus_read_1(sc->io_res, PIIX4_SMBHSTSTS);
453 if (!(status & PIIX4_SMBHSTSTAT_BUSY)) {
455 error = intsmb_error(sc->dev, status);
460 /* Timed out waiting for busy to clear. */
462 tmp = bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
463 bus_write_1(sc->io_res, PIIX4_SMBHSTCNT, tmp & ~PIIX4_SMBHSTCNT_INTREN);
464 return (SMB_ETIMEOUT);
468 * Wait for completion and return result.
471 intsmb_stop(struct intsmb_softc *sc)
475 INTSMB_LOCK_ASSERT(sc);
477 if (sc->poll || cold)
478 /* So that it can use device during device probe on SMBus. */
479 return (intsmb_stop_poll(sc));
481 error = msleep(sc, &sc->lock, PWAIT | PCATCH, "SMBWAI", hz / 8);
483 status = bus_read_1(sc->io_res, PIIX4_SMBHSTSTS);
484 if (!(status & PIIX4_SMBHSTSTAT_BUSY)) {
485 error = intsmb_error(sc->dev, status);
486 if (error == 0 && !(status & PIIX4_SMBHSTSTAT_INTR))
487 device_printf(sc->dev, "unknown cause why?\n");
489 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT,
490 PIIX4_SMBSLVCNT_ALTEN);
496 /* Timeout Procedure. */
499 /* Re-enable supressed interrupt from slave part. */
500 bus_write_1(sc->io_res, PIIX4_SMBSLVCNT, PIIX4_SMBSLVCNT_ALTEN);
501 if (error == EWOULDBLOCK)
502 return (SMB_ETIMEOUT);
508 intsmb_quick(device_t dev, u_char slave, int how)
510 struct intsmb_softc *sc = device_get_softc(dev);
516 /* Quick command is part of Address, I think. */
529 error = intsmb_free(sc);
534 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, data);
535 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_QUICK, 0);
536 error = intsmb_stop(sc);
542 intsmb_sendb(device_t dev, u_char slave, char byte)
544 struct intsmb_softc *sc = device_get_softc(dev);
548 error = intsmb_free(sc);
553 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
554 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, byte);
555 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BYTE, 0);
556 error = intsmb_stop(sc);
562 intsmb_recvb(device_t dev, u_char slave, char *byte)
564 struct intsmb_softc *sc = device_get_softc(dev);
568 error = intsmb_free(sc);
573 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
574 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BYTE, 0);
575 error = intsmb_stop(sc);
577 #ifdef RECV_IS_IN_CMD
579 * Linux SMBus stuff also troubles
580 * Because Intel's datasheet does not make clear.
582 *byte = bus_read_1(sc->io_res, PIIX4_SMBHSTCMD);
584 *byte = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
592 intsmb_writeb(device_t dev, u_char slave, char cmd, char byte)
594 struct intsmb_softc *sc = device_get_softc(dev);
598 error = intsmb_free(sc);
603 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
604 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
605 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, byte);
606 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BDATA, 0);
607 error = intsmb_stop(sc);
613 intsmb_writew(device_t dev, u_char slave, char cmd, short word)
615 struct intsmb_softc *sc = device_get_softc(dev);
619 error = intsmb_free(sc);
624 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
625 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
626 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, word & 0xff);
627 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT1, (word >> 8) & 0xff);
628 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_WDATA, 0);
629 error = intsmb_stop(sc);
635 intsmb_readb(device_t dev, u_char slave, char cmd, char *byte)
637 struct intsmb_softc *sc = device_get_softc(dev);
641 error = intsmb_free(sc);
646 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
647 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
648 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BDATA, 0);
649 error = intsmb_stop(sc);
651 *byte = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
657 intsmb_readw(device_t dev, u_char slave, char cmd, short *word)
659 struct intsmb_softc *sc = device_get_softc(dev);
663 error = intsmb_free(sc);
668 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
669 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
670 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_WDATA, 0);
671 error = intsmb_stop(sc);
673 *word = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
674 *word |= bus_read_1(sc->io_res, PIIX4_SMBHSTDAT1) << 8;
681 * Data sheet claims that it implements all function, but also claims
682 * that it implements 7 function and not mention PCALL. So I don't know
683 * whether it will work.
686 intsmb_pcall(device_t dev, u_char slave, char cmd, short sdata, short *rdata)
689 struct intsmb_softc *sc = device_get_softc(dev);
693 error = intsmb_free(sc);
698 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
699 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
700 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, sdata & 0xff);
701 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT1, (sdata & 0xff) >> 8);
702 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_WDATA, 0);
703 error = intsmb_stop(sc);
705 *rdata = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
706 *rdata |= bus_read_1(sc->io_res, PIIX4_SMBHSTDAT1) << 8;
711 return (SMB_ENOTSUPP);
716 intsmb_bwrite(device_t dev, u_char slave, char cmd, u_char count, char *buf)
718 struct intsmb_softc *sc = device_get_softc(dev);
721 if (count > SMBBLOCKTRANS_MAX || count == 0)
725 error = intsmb_free(sc);
731 /* Reset internal array index. */
732 bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
734 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave & ~LSB);
735 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
736 for (i = 0; i < count; i++)
737 bus_write_1(sc->io_res, PIIX4_SMBBLKDAT, buf[i]);
738 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, count);
739 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BLOCK, 0);
740 error = intsmb_stop(sc);
746 intsmb_bread(device_t dev, u_char slave, char cmd, u_char *count, char *buf)
748 struct intsmb_softc *sc = device_get_softc(dev);
752 if (*count > SMBBLOCKTRANS_MAX || *count == 0)
756 error = intsmb_free(sc);
762 /* Reset internal array index. */
763 bus_read_1(sc->io_res, PIIX4_SMBHSTCNT);
765 bus_write_1(sc->io_res, PIIX4_SMBHSTADD, slave | LSB);
766 bus_write_1(sc->io_res, PIIX4_SMBHSTCMD, cmd);
767 bus_write_1(sc->io_res, PIIX4_SMBHSTDAT0, *count);
768 intsmb_start(sc, PIIX4_SMBHSTCNT_PROT_BLOCK, 0);
769 error = intsmb_stop(sc);
771 nread = bus_read_1(sc->io_res, PIIX4_SMBHSTDAT0);
772 if (nread != 0 && nread <= SMBBLOCKTRANS_MAX) {
773 for (i = 0; i < nread; i++) {
774 data = bus_read_1(sc->io_res, PIIX4_SMBBLKDAT);
786 static devclass_t intsmb_devclass;
788 static device_method_t intsmb_methods[] = {
789 /* Device interface */
790 DEVMETHOD(device_probe, intsmb_probe),
791 DEVMETHOD(device_attach, intsmb_attach),
792 DEVMETHOD(device_detach, intsmb_detach),
794 /* SMBus interface */
795 DEVMETHOD(smbus_callback, intsmb_callback),
796 DEVMETHOD(smbus_quick, intsmb_quick),
797 DEVMETHOD(smbus_sendb, intsmb_sendb),
798 DEVMETHOD(smbus_recvb, intsmb_recvb),
799 DEVMETHOD(smbus_writeb, intsmb_writeb),
800 DEVMETHOD(smbus_writew, intsmb_writew),
801 DEVMETHOD(smbus_readb, intsmb_readb),
802 DEVMETHOD(smbus_readw, intsmb_readw),
803 DEVMETHOD(smbus_pcall, intsmb_pcall),
804 DEVMETHOD(smbus_bwrite, intsmb_bwrite),
805 DEVMETHOD(smbus_bread, intsmb_bread),
810 static driver_t intsmb_driver = {
813 sizeof(struct intsmb_softc),
816 DRIVER_MODULE(intsmb, pci, intsmb_driver, intsmb_devclass, 0, 0);
817 DRIVER_MODULE(smbus, intsmb, smbus_driver, smbus_devclass, 0, 0);
818 MODULE_DEPEND(intsmb, smbus, SMBUS_MINVER, SMBUS_PREFVER, SMBUS_MAXVER);
819 MODULE_VERSION(intsmb, 1);