2 * This file is part of the coreboot project.
4 * Copyright (C) 2008-2009 coresystems GmbH
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; version 2 of
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,
24 #include <arch/romcc_io.h>
25 #include <console/console.h>
26 #include <cpu/x86/cache.h>
27 #include <cpu/x86/smm.h>
28 #include <device/pci_def.h>
34 #define CST_CONTROL 0x85
35 #define PST_CONTROL 0x80
36 #define ACPI_DISABLE 0x1e
37 #define ACPI_ENABLE 0xe1
38 #define GNVS_UPDATE 0xea
39 #define MBI_UPDATE 0xeb
44 #define D_OPEN (1 << 6)
45 #define D_CLS (1 << 5)
46 #define D_LCK (1 << 4)
47 #define G_SMRANE (1 << 3)
48 #define C_BASE_SEG ((0 << 2) | (1 << 1) | (0 << 0))
50 #include "i82801dx_nvs.h"
52 /* While we read PMBASE dynamically in case it changed, let's
53 * initialize it with a sane value
55 u16 pmbase = PMBASE_ADDR;
56 u8 smm_initialized = 0;
58 unsigned char *mbi = NULL;
60 u8 mbi_initialized = 0;
62 /* GNVS needs to be updated by an 0xEA PM Trap (B2) after it has been located
65 global_nvs_t *gnvs = (global_nvs_t *)0x0;
66 void *tcg = (void *)0x0;
67 void *smi1 = (void *)0x0;
70 * @brief read and clear PM1_STS
71 * @return PM1_STS register
73 static u16 reset_pm1_status(void)
77 reg16 = inw(pmbase + PM1_STS);
78 /* set status bits are cleared by writing 1 to them */
79 outw(reg16, pmbase + PM1_STS);
84 static void dump_pm1_status(u16 pm1_sts)
86 printk_spew("PM1_STS: ");
87 if (pm1_sts & (1 << 15)) printk_spew("WAK ");
88 if (pm1_sts & (1 << 14)) printk_spew("PCIEXPWAK ");
89 if (pm1_sts & (1 << 11)) printk_spew("PRBTNOR ");
90 if (pm1_sts & (1 << 10)) printk_spew("RTC ");
91 if (pm1_sts & (1 << 8)) printk_spew("PWRBTN ");
92 if (pm1_sts & (1 << 5)) printk_spew("GBL ");
93 if (pm1_sts & (1 << 4)) printk_spew("BM ");
94 if (pm1_sts & (1 << 0)) printk_spew("TMROF ");
96 int reg16 = inw(pmbase + PM1_EN);
97 printk_spew("PM1_EN: %x\n", reg16);
101 * @brief read and clear SMI_STS
102 * @return SMI_STS register
104 static u32 reset_smi_status(void)
108 reg32 = inl(pmbase + SMI_STS);
109 /* set status bits are cleared by writing 1 to them */
110 outl(reg32, pmbase + SMI_STS);
115 static void dump_smi_status(u32 smi_sts)
117 printk_debug("SMI_STS: ");
118 if (smi_sts & (1 << 26)) printk_debug("SPI ");
119 if (smi_sts & (1 << 25)) printk_debug("EL_SMI ");
120 if (smi_sts & (1 << 21)) printk_debug("MONITOR ");
121 if (smi_sts & (1 << 20)) printk_debug("PCI_EXP_SMI ");
122 if (smi_sts & (1 << 18)) printk_debug("INTEL_USB2 ");
123 if (smi_sts & (1 << 17)) printk_debug("LEGACY_USB2 ");
124 if (smi_sts & (1 << 16)) printk_debug("SMBUS_SMI ");
125 if (smi_sts & (1 << 15)) printk_debug("SERIRQ_SMI ");
126 if (smi_sts & (1 << 14)) printk_debug("PERIODIC ");
127 if (smi_sts & (1 << 13)) printk_debug("TCO ");
128 if (smi_sts & (1 << 12)) printk_debug("DEVMON ");
129 if (smi_sts & (1 << 11)) printk_debug("MCSMI ");
130 if (smi_sts & (1 << 10)) printk_debug("GPI ");
131 if (smi_sts & (1 << 9)) printk_debug("GPE0 ");
132 if (smi_sts & (1 << 8)) printk_debug("PM1 ");
133 if (smi_sts & (1 << 6)) printk_debug("SWSMI_TMR ");
134 if (smi_sts & (1 << 5)) printk_debug("APM ");
135 if (smi_sts & (1 << 4)) printk_debug("SLP_SMI ");
136 if (smi_sts & (1 << 3)) printk_debug("LEGACY_USB ");
137 if (smi_sts & (1 << 2)) printk_debug("BIOS ");
143 * @brief read and clear GPE0_STS
144 * @return GPE0_STS register
146 static u32 reset_gpe0_status(void)
150 reg32 = inl(pmbase + GPE0_STS);
151 /* set status bits are cleared by writing 1 to them */
152 outl(reg32, pmbase + GPE0_STS);
157 static void dump_gpe0_status(u32 gpe0_sts)
160 printk_debug("GPE0_STS: ");
161 for (i=31; i<= 16; i--) {
162 if (gpe0_sts & (1 << i)) printk_debug("GPIO%d ", (i-16));
164 if (gpe0_sts & (1 << 14)) printk_debug("USB4 ");
165 if (gpe0_sts & (1 << 13)) printk_debug("PME_B0 ");
166 if (gpe0_sts & (1 << 12)) printk_debug("USB3 ");
167 if (gpe0_sts & (1 << 11)) printk_debug("PME ");
168 if (gpe0_sts & (1 << 10)) printk_debug("EL_SCI/BATLOW ");
169 if (gpe0_sts & (1 << 9)) printk_debug("PCI_EXP ");
170 if (gpe0_sts & (1 << 8)) printk_debug("RI ");
171 if (gpe0_sts & (1 << 7)) printk_debug("SMB_WAK ");
172 if (gpe0_sts & (1 << 6)) printk_debug("TCO_SCI ");
173 if (gpe0_sts & (1 << 5)) printk_debug("AC97 ");
174 if (gpe0_sts & (1 << 4)) printk_debug("USB2 ");
175 if (gpe0_sts & (1 << 3)) printk_debug("USB1 ");
176 if (gpe0_sts & (1 << 2)) printk_debug("HOT_PLUG ");
177 if (gpe0_sts & (1 << 0)) printk_debug("THRM ");
183 * @brief read and clear TCOx_STS
184 * @return TCOx_STS registers
186 static u32 reset_tco_status(void)
188 u32 tcobase = pmbase + 0x60;
191 reg32 = inl(tcobase + 0x04);
192 /* set status bits are cleared by writing 1 to them */
193 outl(reg32 & ~(1<<18), tcobase + 0x04); // Don't clear BOOT_STS before SECOND_TO_STS
194 if (reg32 & (1 << 18))
195 outl(reg32 & (1<<18), tcobase + 0x04); // clear BOOT_STS
201 static void dump_tco_status(u32 tco_sts)
203 printk_debug("TCO_STS: ");
204 if (tco_sts & (1 << 20)) printk_debug("SMLINK_SLV ");
205 if (tco_sts & (1 << 18)) printk_debug("BOOT ");
206 if (tco_sts & (1 << 17)) printk_debug("SECOND_TO ");
207 if (tco_sts & (1 << 16)) printk_debug("INTRD_DET ");
208 if (tco_sts & (1 << 12)) printk_debug("DMISERR ");
209 if (tco_sts & (1 << 10)) printk_debug("DMISMI ");
210 if (tco_sts & (1 << 9)) printk_debug("DMISCI ");
211 if (tco_sts & (1 << 8)) printk_debug("BIOSWR ");
212 if (tco_sts & (1 << 7)) printk_debug("NEWCENTURY ");
213 if (tco_sts & (1 << 3)) printk_debug("TIMEOUT ");
214 if (tco_sts & (1 << 2)) printk_debug("TCO_INT ");
215 if (tco_sts & (1 << 1)) printk_debug("SW_TCO ");
216 if (tco_sts & (1 << 0)) printk_debug("NMI2SMI ");
220 /* We are using PCIe accesses for now
221 * 1. the chipset can do it
222 * 2. we don't need to worry about how we leave 0xcf8/0xcfc behind
224 // #include "../../../northbridge/intel/i945/pcie_config.c"
226 int southbridge_io_trap_handler(int smif)
230 printk_debug("OS Init\n");
232 * On success, the IO Trap Handler returns 0
233 * On failure, the IO Trap Handler returns a value != 0
236 return 1; /* IO trap handled */
244 * @brief Set the EOS bit
246 void southbridge_smi_set_eos(void)
250 reg8 = inb(pmbase + SMI_EN);
252 outb(reg8, pmbase + SMI_EN);
255 static void busmaster_disable_on_bus(int bus)
261 for (slot = 0; slot < 0x20; slot++) {
262 for (func = 0; func < 8; func++) {
264 device_t dev = PCI_DEV(bus, slot, func);
266 val = pci_read_config32(dev, PCI_VENDOR_ID);
268 if (val == 0xffffffff || val == 0x00000000 ||
269 val == 0x0000ffff || val == 0xffff0000)
272 /* Disable Bus Mastering for this one device */
273 reg32 = pci_read_config32(dev, PCI_COMMAND);
274 reg32 &= ~PCI_COMMAND_MASTER;
275 pci_write_config32(dev, PCI_COMMAND, reg32);
277 /* If this is a bridge, then follow it. */
278 hdr = pci_read_config8(dev, PCI_HEADER_TYPE);
280 if (hdr == PCI_HEADER_TYPE_BRIDGE ||
281 hdr == PCI_HEADER_TYPE_CARDBUS) {
283 buses = pci_read_config32(dev, PCI_PRIMARY_BUS);
284 busmaster_disable_on_bus((buses >> 8) & 0xff);
291 static void southbridge_smi_sleep(unsigned int node, smm_state_save_area_t *state_save)
296 /* FIXME: the power state on boot should be read from
297 * CMOS or even better from GNVS. Right now it's hard
298 * coded at compile time.
300 u8 s5pwr = CONFIG_MAINBOARD_POWER_ON_AFTER_POWER_FAIL;
302 /* First, disable further SMIs */
303 reg8 = inb(pmbase + SMI_EN);
305 outb(reg8, pmbase + SMI_EN);
307 /* Figure out SLP_TYP */
308 reg32 = inl(pmbase + PM1_CNT);
309 printk_spew("SMI#: SLP = 0x%08x\n", reg32);
310 slp_typ = (reg32 >> 10) & 7;
312 /* Next, do the deed.
316 case 0: printk_debug("SMI#: Entering S0 (On)\n"); break;
317 case 1: printk_debug("SMI#: Entering S1 (Assert STPCLK#)\n"); break;
319 printk_debug("SMI#: Entering S3 (Suspend-To-RAM)\n");
320 /* Invalidate the cache before going to S3 */
323 case 6: printk_debug("SMI#: Entering S4 (Suspend-To-Disk)\n"); break;
325 printk_debug("SMI#: Entering S5 (Soft Power off)\n");
327 outl(0, pmbase + GPE0_EN);
329 /* Should we keep the power state after a power loss?
330 * In case the setting is "ON" or "OFF" we don't have
331 * to do anything. But if it's "KEEP" we have to switch
332 * to "OFF" before entering S5.
334 if (s5pwr == MAINBOARD_POWER_KEEP) {
335 reg8 = pci_read_config8(PCI_DEV(0, 0x1f, 0), GEN_PMCON_3);
337 pci_write_config8(PCI_DEV(0, 0x1f, 0), GEN_PMCON_3, reg8);
340 /* also iterates over all bridges on bus 0 */
341 busmaster_disable_on_bus(0);
343 default: printk_debug("SMI#: ERROR: SLP_TYP reserved\n"); break;
346 /* Write back to the SLP register to cause the originally intended
347 * event again. We need to set BIT13 (SLP_EN) though to make the
350 outl(reg32 | SLP_EN, pmbase + PM1_CNT);
352 /* In most sleep states, the code flow of this function ends at
353 * the line above. However, if we entered sleep state S1 and wake
354 * up again, we will continue to execute code in this function.
356 reg32 = inl(pmbase + PM1_CNT);
357 if (reg32 & SCI_EN) {
358 /* The OS is not an ACPI OS, so we set the state to S0 */
359 reg32 &= ~(SLP_EN | SLP_TYP);
360 outl(reg32, pmbase + PM1_CNT);
364 static void southbridge_smi_apmc(unsigned int node, smm_state_save_area_t *state_save)
369 /* Emulate B2 register as the FADT / Linux expects it */
374 /* Calling this function seems to cause
375 * some kind of race condition in Linux
376 * and causes a kernel oops
378 printk_debug("C-state control\n");
381 /* Calling this function seems to cause
382 * some kind of race condition in Linux
383 * and causes a kernel oops
385 printk_debug("P-state control\n");
388 pmctrl = inl(pmbase + PM1_CNT);
390 outl(pmctrl, pmbase + PM1_CNT);
391 printk_debug("SMI#: ACPI disabled.\n");
394 pmctrl = inl(pmbase + PM1_CNT);
396 outl(pmctrl, pmbase + PM1_CNT);
397 printk_debug("SMI#: ACPI enabled.\n");
400 if (smm_initialized) {
401 printk_debug("SMI#: SMM structures already initialized!\n");
404 gnvs = *(global_nvs_t **)0x500;
405 tcg = *(void **)0x504;
406 smi1 = *(void **)0x508;
408 printk_debug("SMI#: Setting up structures to %p, %p, %p\n", gnvs, tcg, smi1);
410 case MBI_UPDATE: // FIXME
411 if (mbi_initialized) {
412 printk_debug("SMI#: mbi already registered!\n");
415 mbi = *(void **)0x500;
416 mbi_len = *(u32 *)0x504;
418 printk_debug("SMI#: Registered MBI at %p (%d bytes)\n", mbi, mbi_len);
422 printk_debug("SMI#: Unknown function APM_CNT=%02x\n", reg8);
426 static void southbridge_smi_pm1(unsigned int node, smm_state_save_area_t *state_save)
430 pm1_sts = reset_pm1_status();
431 dump_pm1_status(pm1_sts);
433 /* While OSPM is not active, poweroff immediately
434 * on a power button event.
436 if (pm1_sts & PWRBTN_STS) {
437 // power button pressed
439 reg32 = (7 << 10) | (1 << 13);
440 outl(reg32, pmbase + PM1_CNT);
444 static void southbridge_smi_gpe0(unsigned int node, smm_state_save_area_t *state_save)
448 gpe0_sts = reset_gpe0_status();
449 dump_gpe0_status(gpe0_sts);
452 void __attribute__((weak)) mainboard_smi_gpi(u16 gpi_sts);
454 static void southbridge_smi_gpi(unsigned int node, smm_state_save_area_t *state_save)
457 reg16 = inw(pmbase + ALT_GP_SMI_STS);
458 outl(reg16, pmbase + ALT_GP_SMI_STS);
460 reg16 &= inw(pmbase + ALT_GP_SMI_EN);
462 if (mainboard_smi_gpi) {
463 mainboard_smi_gpi(reg16);
466 printk_debug("GPI (mask %04x)\n",reg16);
470 static void southbridge_smi_mc(unsigned int node, smm_state_save_area_t *state_save)
474 reg32 = inl(pmbase + SMI_EN);
476 /* Are periodic SMIs enabled? */
477 if ((reg32 & MCSMI_EN) == 0)
480 printk_debug("Microcontroller SMI.\n");
485 static void southbridge_smi_tco(unsigned int node, smm_state_save_area_t *state_save)
489 tco_sts = reset_tco_status();
495 if (tco_sts & (1 << 8)) { // BIOSWR
498 bios_cntl = pci_read_config16(PCI_DEV(0, 0x1f, 0), 0xdc);
501 /* BWE is RW, so the SMI was caused by a
502 * write to BWE, not by a write to the BIOS
505 /* This is the place where we notice someone
506 * is trying to tinker with the BIOS. We are
507 * trying to be nice and just ignore it. A more
508 * resolute answer would be to power down the
511 printk_debug("Switching back to RO\n");
512 pci_write_config32(PCI_DEV(0, 0x1f, 0), 0xdc, (bios_cntl & ~1));
513 } /* No else for now? */
514 } else if (tco_sts & (1 << 3)) { /* TIMEOUT */
515 /* Handle TCO timeout */
516 printk_debug("TCO Timeout.\n");
517 } else if (!tco_sts) {
518 dump_tco_status(tco_sts);
522 static void southbridge_smi_periodic(unsigned int node, smm_state_save_area_t *state_save)
526 reg32 = inl(pmbase + SMI_EN);
528 /* Are periodic SMIs enabled? */
529 if ((reg32 & PERIODIC_EN) == 0)
532 printk_debug("Periodic SMI.\n");
535 static void southbridge_smi_monitor(unsigned int node, smm_state_save_area_t *state_save)
537 #define IOTRAP(x) (trap_sts & (1 << x))
539 u32 trap_sts, trap_cycle;
543 trap_sts = RCBA32(0x1e00); // TRSR - Trap Status Register
544 RCBA32(0x1e00) = trap_sts; // Clear trap(s) in TRSR
546 trap_cycle = RCBA32(0x1e10);
547 for (i=16; i<20; i++) {
548 if (trap_cycle & (1 << i))
549 mask |= (0xff << ((i - 16) << 2));
553 /* IOTRAP(3) SMI function call */
555 if (gnvs && gnvs->smif)
556 io_trap_handler(gnvs->smif); // call function smif
560 /* IOTRAP(2) currently unused
561 * IOTRAP(1) currently unused */
565 if (!(trap_cycle & (1 << 24))) { // It's a write
566 printk_debug("SMI1 command\n");
567 data = RCBA32(0x1e18);
570 // southbridge_smi_command(data);
573 // Fall through to debug
576 printk_debug(" trapped io address = 0x%x\n", trap_cycle & 0xfffc);
577 for (i=0; i < 4; i++) if(IOTRAP(i)) printk_debug(" TRAPĀ = %d\n", i);
578 printk_debug(" AHBE = %x\n", (trap_cycle >> 16) & 0xf);
579 printk_debug(" MASK = 0x%08x\n", mask);
580 printk_debug(" read/write: %s\n", (trap_cycle & (1 << 24)) ? "read" : "write");
582 if (!(trap_cycle & (1 << 24))) {
584 data = RCBA32(0x1e18);
585 printk_debug(" iotrap written data = 0x%08x\n", data);
591 typedef void (*smi_handler_t)(unsigned int node,
592 smm_state_save_area_t *state_save);
594 smi_handler_t southbridge_smi[32] = {
595 NULL, // [0] reserved
596 NULL, // [1] reserved
597 NULL, // [2] BIOS_STS
598 NULL, // [3] LEGACY_USB_STS
599 southbridge_smi_sleep, // [4] SLP_SMI_STS
600 southbridge_smi_apmc, // [5] APM_STS
601 NULL, // [6] SWSMI_TMR_STS
602 NULL, // [7] reserved
603 southbridge_smi_pm1, // [8] PM1_STS
604 southbridge_smi_gpe0, // [9] GPE0_STS
605 southbridge_smi_gpi, // [10] GPI_STS
606 southbridge_smi_mc, // [11] MCSMI_STS
607 NULL, // [12] DEVMON_STS
608 southbridge_smi_tco, // [13] TCO_STS
609 southbridge_smi_periodic, // [14] PERIODIC_STS
610 NULL, // [15] SERIRQ_SMI_STS
611 NULL, // [16] SMBUS_SMI_STS
612 NULL, // [17] LEGACY_USB2_STS
613 NULL, // [18] INTEL_USB2_STS
614 NULL, // [19] reserved
615 NULL, // [20] PCI_EXP_SMI_STS
616 southbridge_smi_monitor, // [21] MONITOR_STS
617 NULL, // [22] reserved
618 NULL, // [23] reserved
619 NULL, // [24] reserved
620 NULL, // [25] EL_SMI_STS
621 NULL, // [26] SPI_STS
622 NULL, // [27] reserved
623 NULL, // [28] reserved
624 NULL, // [29] reserved
625 NULL, // [30] reserved
626 NULL // [31] reserved
630 * @brief Interrupt handler for SMI#
632 * @param smm_revision revision of the smm state save map
635 void southbridge_smi_handler(unsigned int node, smm_state_save_area_t *state_save)
640 /* Update global variable pmbase */
641 pmbase = pci_read_config16(PCI_DEV(0, 0x1f, 0), 0x40) & 0xfffc;
643 /* We need to clear the SMI status registers, or we won't see what's
644 * happening in the following calls.
646 smi_sts = reset_smi_status();
648 /* Filter all non-enabled SMI events */
649 // FIXME Double check, this clears MONITOR
650 // smi_sts &= inl(pmbase + SMI_EN);
652 /* Call SMI sub handler for each of the status bits */
653 for (i = 0; i < 31; i++) {
654 if (smi_sts & (1 << i)) {
655 if (southbridge_smi[i])
656 southbridge_smi[i](node, state_save);
658 printk_debug("SMI_STS[%d] occured, but no "
659 "handler available.\n", i);
666 dump_smi_status(smi_sts);