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>
29 #include <pc80/mc146818rtc.h>
34 #define D_OPEN (1 << 6)
35 #define D_CLS (1 << 5)
36 #define D_LCK (1 << 4)
37 #define G_SMRANE (1 << 3)
38 #define C_BASE_SEG ((0 << 2) | (1 << 1) | (0 << 0))
42 /* While we read PMBASE dynamically in case it changed, let's
43 * initialize it with a sane value
45 u16 pmbase = DEFAULT_PMBASE;
46 u8 smm_initialized = 0;
48 /* GNVS needs to be updated by an 0xEA PM Trap (B2) after it has been located
51 global_nvs_t *gnvs = (global_nvs_t *)0x0;
52 void *tcg = (void *)0x0;
53 void *smi1 = (void *)0x0;
56 * @brief read and clear PM1_STS
57 * @return PM1_STS register
59 static u16 reset_pm1_status(void)
63 reg16 = inw(pmbase + PM1_STS);
64 /* set status bits are cleared by writing 1 to them */
65 outw(reg16, pmbase + PM1_STS);
70 static void dump_pm1_status(u16 pm1_sts)
72 printk(BIOS_SPEW, "PM1_STS: ");
73 if (pm1_sts & (1 << 15)) printk(BIOS_SPEW, "WAK ");
74 if (pm1_sts & (1 << 14)) printk(BIOS_SPEW, "PCIEXPWAK ");
75 if (pm1_sts & (1 << 11)) printk(BIOS_SPEW, "PRBTNOR ");
76 if (pm1_sts & (1 << 10)) printk(BIOS_SPEW, "RTC ");
77 if (pm1_sts & (1 << 8)) printk(BIOS_SPEW, "PWRBTN ");
78 if (pm1_sts & (1 << 5)) printk(BIOS_SPEW, "GBL ");
79 if (pm1_sts & (1 << 4)) printk(BIOS_SPEW, "BM ");
80 if (pm1_sts & (1 << 0)) printk(BIOS_SPEW, "TMROF ");
81 printk(BIOS_SPEW, "\n");
82 int reg16 = inw(pmbase + PM1_EN);
83 printk(BIOS_SPEW, "PM1_EN: %x\n", reg16);
87 * @brief read and clear SMI_STS
88 * @return SMI_STS register
90 static u32 reset_smi_status(void)
94 reg32 = inl(pmbase + SMI_STS);
95 /* set status bits are cleared by writing 1 to them */
96 outl(reg32, pmbase + SMI_STS);
101 static void dump_smi_status(u32 smi_sts)
103 printk(BIOS_DEBUG, "SMI_STS: ");
104 if (smi_sts & (1 << 26)) printk(BIOS_DEBUG, "SPI ");
105 if (smi_sts & (1 << 25)) printk(BIOS_DEBUG, "EL_SMI ");
106 if (smi_sts & (1 << 21)) printk(BIOS_DEBUG, "MONITOR ");
107 if (smi_sts & (1 << 20)) printk(BIOS_DEBUG, "PCI_EXP_SMI ");
108 if (smi_sts & (1 << 18)) printk(BIOS_DEBUG, "INTEL_USB2 ");
109 if (smi_sts & (1 << 17)) printk(BIOS_DEBUG, "LEGACY_USB2 ");
110 if (smi_sts & (1 << 16)) printk(BIOS_DEBUG, "SMBUS_SMI ");
111 if (smi_sts & (1 << 15)) printk(BIOS_DEBUG, "SERIRQ_SMI ");
112 if (smi_sts & (1 << 14)) printk(BIOS_DEBUG, "PERIODIC ");
113 if (smi_sts & (1 << 13)) printk(BIOS_DEBUG, "TCO ");
114 if (smi_sts & (1 << 12)) printk(BIOS_DEBUG, "DEVMON ");
115 if (smi_sts & (1 << 11)) printk(BIOS_DEBUG, "MCSMI ");
116 if (smi_sts & (1 << 10)) printk(BIOS_DEBUG, "GPI ");
117 if (smi_sts & (1 << 9)) printk(BIOS_DEBUG, "GPE0 ");
118 if (smi_sts & (1 << 8)) printk(BIOS_DEBUG, "PM1 ");
119 if (smi_sts & (1 << 6)) printk(BIOS_DEBUG, "SWSMI_TMR ");
120 if (smi_sts & (1 << 5)) printk(BIOS_DEBUG, "APM ");
121 if (smi_sts & (1 << 4)) printk(BIOS_DEBUG, "SLP_SMI ");
122 if (smi_sts & (1 << 3)) printk(BIOS_DEBUG, "LEGACY_USB ");
123 if (smi_sts & (1 << 2)) printk(BIOS_DEBUG, "BIOS ");
124 printk(BIOS_DEBUG, "\n");
129 * @brief read and clear GPE0_STS
130 * @return GPE0_STS register
132 static u32 reset_gpe0_status(void)
136 reg32 = inl(pmbase + GPE0_STS);
137 /* set status bits are cleared by writing 1 to them */
138 outl(reg32, pmbase + GPE0_STS);
143 static void dump_gpe0_status(u32 gpe0_sts)
146 printk(BIOS_DEBUG, "GPE0_STS: ");
147 for (i=31; i<= 16; i--) {
148 if (gpe0_sts & (1 << i)) printk(BIOS_DEBUG, "GPIO%d ", (i-16));
150 if (gpe0_sts & (1 << 14)) printk(BIOS_DEBUG, "USB4 ");
151 if (gpe0_sts & (1 << 13)) printk(BIOS_DEBUG, "PME_B0 ");
152 if (gpe0_sts & (1 << 12)) printk(BIOS_DEBUG, "USB3 ");
153 if (gpe0_sts & (1 << 11)) printk(BIOS_DEBUG, "PME ");
154 if (gpe0_sts & (1 << 10)) printk(BIOS_DEBUG, "EL_SCI/BATLOW ");
155 if (gpe0_sts & (1 << 9)) printk(BIOS_DEBUG, "PCI_EXP ");
156 if (gpe0_sts & (1 << 8)) printk(BIOS_DEBUG, "RI ");
157 if (gpe0_sts & (1 << 7)) printk(BIOS_DEBUG, "SMB_WAK ");
158 if (gpe0_sts & (1 << 6)) printk(BIOS_DEBUG, "TCO_SCI ");
159 if (gpe0_sts & (1 << 5)) printk(BIOS_DEBUG, "AC97 ");
160 if (gpe0_sts & (1 << 4)) printk(BIOS_DEBUG, "USB2 ");
161 if (gpe0_sts & (1 << 3)) printk(BIOS_DEBUG, "USB1 ");
162 if (gpe0_sts & (1 << 2)) printk(BIOS_DEBUG, "HOT_PLUG ");
163 if (gpe0_sts & (1 << 0)) printk(BIOS_DEBUG, "THRM ");
164 printk(BIOS_DEBUG, "\n");
169 * @brief read and clear TCOx_STS
170 * @return TCOx_STS registers
172 static u32 reset_tco_status(void)
174 u32 tcobase = pmbase + 0x60;
177 reg32 = inl(tcobase + 0x04);
178 /* set status bits are cleared by writing 1 to them */
179 outl(reg32 & ~(1<<18), tcobase + 0x04); // Don't clear BOOT_STS before SECOND_TO_STS
180 if (reg32 & (1 << 18))
181 outl(reg32 & (1<<18), tcobase + 0x04); // clear BOOT_STS
187 static void dump_tco_status(u32 tco_sts)
189 printk(BIOS_DEBUG, "TCO_STS: ");
190 if (tco_sts & (1 << 20)) printk(BIOS_DEBUG, "SMLINK_SLV ");
191 if (tco_sts & (1 << 18)) printk(BIOS_DEBUG, "BOOT ");
192 if (tco_sts & (1 << 17)) printk(BIOS_DEBUG, "SECOND_TO ");
193 if (tco_sts & (1 << 16)) printk(BIOS_DEBUG, "INTRD_DET ");
194 if (tco_sts & (1 << 12)) printk(BIOS_DEBUG, "DMISERR ");
195 if (tco_sts & (1 << 10)) printk(BIOS_DEBUG, "DMISMI ");
196 if (tco_sts & (1 << 9)) printk(BIOS_DEBUG, "DMISCI ");
197 if (tco_sts & (1 << 8)) printk(BIOS_DEBUG, "BIOSWR ");
198 if (tco_sts & (1 << 7)) printk(BIOS_DEBUG, "NEWCENTURY ");
199 if (tco_sts & (1 << 3)) printk(BIOS_DEBUG, "TIMEOUT ");
200 if (tco_sts & (1 << 2)) printk(BIOS_DEBUG, "TCO_INT ");
201 if (tco_sts & (1 << 1)) printk(BIOS_DEBUG, "SW_TCO ");
202 if (tco_sts & (1 << 0)) printk(BIOS_DEBUG, "NMI2SMI ");
203 printk(BIOS_DEBUG, "\n");
206 /* We are using PCIe accesses for now
207 * 1. the chipset can do it
208 * 2. we don't need to worry about how we leave 0xcf8/0xcfc behind
210 #include "../../../northbridge/intel/i945/pcie_config.c"
212 int southbridge_io_trap_handler(int smif)
216 printk(BIOS_DEBUG, "OS Init\n");
218 * On success, the IO Trap Handler returns 0
219 * On failure, the IO Trap Handler returns a value != 0
222 return 1; /* IO trap handled */
230 * @brief Set the EOS bit
232 void southbridge_smi_set_eos(void)
236 reg8 = inb(pmbase + SMI_EN);
238 outb(reg8, pmbase + SMI_EN);
241 static void busmaster_disable_on_bus(int bus)
247 for (slot = 0; slot < 0x20; slot++) {
248 for (func = 0; func < 8; func++) {
250 device_t dev = PCI_DEV(bus, slot, func);
252 val = pci_read_config32(dev, PCI_VENDOR_ID);
254 if (val == 0xffffffff || val == 0x00000000 ||
255 val == 0x0000ffff || val == 0xffff0000)
258 /* Disable Bus Mastering for this one device */
259 reg32 = pci_read_config32(dev, PCI_COMMAND);
260 reg32 &= ~PCI_COMMAND_MASTER;
261 pci_write_config32(dev, PCI_COMMAND, reg32);
263 /* If this is a bridge, then follow it. */
264 hdr = pci_read_config8(dev, PCI_HEADER_TYPE);
266 if (hdr == PCI_HEADER_TYPE_BRIDGE ||
267 hdr == PCI_HEADER_TYPE_CARDBUS) {
269 buses = pci_read_config32(dev, PCI_PRIMARY_BUS);
270 busmaster_disable_on_bus((buses >> 8) & 0xff);
277 static void southbridge_smi_sleep(unsigned int node, smm_state_save_area_t *state_save)
282 /* FIXME: the power state on boot should be read from
283 * CMOS or even better from GNVS. Right now it's hard
284 * coded at compile time.
286 u8 s5pwr = CONFIG_MAINBOARD_POWER_ON_AFTER_POWER_FAIL;
288 /* First, disable further SMIs */
289 reg8 = inb(pmbase + SMI_EN);
291 outb(reg8, pmbase + SMI_EN);
293 /* Figure out SLP_TYP */
294 reg32 = inl(pmbase + PM1_CNT);
295 printk(BIOS_SPEW, "SMI#: SLP = 0x%08x\n", reg32);
296 slp_typ = (reg32 >> 10) & 7;
298 /* Next, do the deed.
302 case 0: printk(BIOS_DEBUG, "SMI#: Entering S0 (On)\n"); break;
303 case 1: printk(BIOS_DEBUG, "SMI#: Entering S1 (Assert STPCLK#)\n"); break;
305 printk(BIOS_DEBUG, "SMI#: Entering S3 (Suspend-To-RAM)\n");
306 /* Invalidate the cache before going to S3 */
309 case 6: printk(BIOS_DEBUG, "SMI#: Entering S4 (Suspend-To-Disk)\n"); break;
311 printk(BIOS_DEBUG, "SMI#: Entering S5 (Soft Power off)\n");
313 outl(0, pmbase + GPE0_EN);
315 /* Should we keep the power state after a power loss?
316 * In case the setting is "ON" or "OFF" we don't have
317 * to do anything. But if it's "KEEP" we have to switch
318 * to "OFF" before entering S5.
320 if (s5pwr == MAINBOARD_POWER_KEEP) {
321 reg8 = pcie_read_config8(PCI_DEV(0, 0x1f, 0), GEN_PMCON_3);
323 pcie_write_config8(PCI_DEV(0, 0x1f, 0), GEN_PMCON_3, reg8);
326 /* also iterates over all bridges on bus 0 */
327 busmaster_disable_on_bus(0);
329 default: printk(BIOS_DEBUG, "SMI#: ERROR: SLP_TYP reserved\n"); break;
332 /* Unlock the SMI semaphore. We're currently in SMM, and the semaphore
333 * will never be unlocked because the next outl will switch off the CPU.
334 * This might open a small race between the smi_release_lock() and the outl()
335 * for other SMI handlers. Not sure if this could cause trouble. */
339 /* Write back to the SLP register to cause the originally intended
340 * event again. We need to set BIT13 (SLP_EN) though to make the
343 outl(reg32 | SLP_EN, pmbase + PM1_CNT);
345 /* In most sleep states, the code flow of this function ends at
346 * the line above. However, if we entered sleep state S1 and wake
347 * up again, we will continue to execute code in this function.
349 reg32 = inl(pmbase + PM1_CNT);
350 if (reg32 & SCI_EN) {
351 /* The OS is not an ACPI OS, so we set the state to S0 */
352 reg32 &= ~(SLP_EN | SLP_TYP);
353 outl(reg32, pmbase + PM1_CNT);
357 static void southbridge_smi_apmc(unsigned int node, smm_state_save_area_t *state_save)
362 /* Emulate B2 register as the FADT / Linux expects it */
365 if (mainboard_apm_cnt && mainboard_apm_cnt(reg8))
369 case APM_CNT_CST_CONTROL:
370 /* Calling this function seems to cause
371 * some kind of race condition in Linux
372 * and causes a kernel oops
374 printk(BIOS_DEBUG, "C-state control\n");
376 case APM_CNT_PST_CONTROL:
377 /* Calling this function seems to cause
378 * some kind of race condition in Linux
379 * and causes a kernel oops
381 printk(BIOS_DEBUG, "P-state control\n");
383 case APM_CNT_ACPI_DISABLE:
384 pmctrl = inl(pmbase + PM1_CNT);
386 outl(pmctrl, pmbase + PM1_CNT);
387 printk(BIOS_DEBUG, "SMI#: ACPI disabled.\n");
389 case APM_CNT_ACPI_ENABLE:
390 pmctrl = inl(pmbase + PM1_CNT);
392 outl(pmctrl, pmbase + PM1_CNT);
393 printk(BIOS_DEBUG, "SMI#: ACPI enabled.\n");
395 case APM_CNT_GNVS_UPDATE:
396 if (smm_initialized) {
397 printk(BIOS_DEBUG, "SMI#: SMM structures already initialized!\n");
400 gnvs = *(global_nvs_t **)0x500;
401 tcg = *(void **)0x504;
402 smi1 = *(void **)0x508;
404 printk(BIOS_DEBUG, "SMI#: Setting up structures to %p, %p, %p\n", gnvs, tcg, smi1);
407 printk(BIOS_DEBUG, "SMI#: Unknown function APM_CNT=%02x\n", reg8);
411 static void southbridge_smi_pm1(unsigned int node, smm_state_save_area_t *state_save)
414 volatile u8 cmos_status;
416 pm1_sts = reset_pm1_status();
417 dump_pm1_status(pm1_sts);
419 /* While OSPM is not active, poweroff immediately
420 * on a power button event.
422 if (pm1_sts & PWRBTN_STS) {
423 // power button pressed
425 reg32 = (7 << 10) | (1 << 13);
426 outl(reg32, pmbase + PM1_CNT);
429 if (pm1_sts & RTC_STS) {
430 /* read RTC status register to disable the interrupt */
431 cmos_status = cmos_read(RTC_REG_C);
432 printk(BIOS_DEBUG, "RTC IRQ status: %02X\n", cmos_status);
436 static void southbridge_smi_gpe0(unsigned int node, smm_state_save_area_t *state_save)
440 gpe0_sts = reset_gpe0_status();
441 dump_gpe0_status(gpe0_sts);
444 static void southbridge_smi_gpi(unsigned int node, smm_state_save_area_t *state_save)
447 reg16 = inw(pmbase + ALT_GP_SMI_STS);
448 outl(reg16, pmbase + ALT_GP_SMI_STS);
450 reg16 &= inw(pmbase + ALT_GP_SMI_EN);
452 if (mainboard_smi_gpi) {
453 mainboard_smi_gpi(reg16);
456 printk(BIOS_DEBUG, "GPI (mask %04x)\n",reg16);
460 static void southbridge_smi_mc(unsigned int node, smm_state_save_area_t *state_save)
464 reg32 = inl(pmbase + SMI_EN);
466 /* Are periodic SMIs enabled? */
467 if ((reg32 & MCSMI_EN) == 0)
470 printk(BIOS_DEBUG, "Microcontroller SMI.\n");
475 static void southbridge_smi_tco(unsigned int node, smm_state_save_area_t *state_save)
479 tco_sts = reset_tco_status();
485 if (tco_sts & (1 << 8)) { // BIOSWR
488 bios_cntl = pcie_read_config16(PCI_DEV(0, 0x1f, 0), 0xdc);
491 /* BWE is RW, so the SMI was caused by a
492 * write to BWE, not by a write to the BIOS
495 /* This is the place where we notice someone
496 * is trying to tinker with the BIOS. We are
497 * trying to be nice and just ignore it. A more
498 * resolute answer would be to power down the
501 printk(BIOS_DEBUG, "Switching back to RO\n");
502 pcie_write_config32(PCI_DEV(0, 0x1f, 0), 0xdc, (bios_cntl & ~1));
503 } /* No else for now? */
504 } else if (tco_sts & (1 << 3)) { /* TIMEOUT */
505 /* Handle TCO timeout */
506 printk(BIOS_DEBUG, "TCO Timeout.\n");
507 } else if (!tco_sts) {
508 dump_tco_status(tco_sts);
512 static void southbridge_smi_periodic(unsigned int node, smm_state_save_area_t *state_save)
516 reg32 = inl(pmbase + SMI_EN);
518 /* Are periodic SMIs enabled? */
519 if ((reg32 & PERIODIC_EN) == 0)
522 printk(BIOS_DEBUG, "Periodic SMI.\n");
525 static void southbridge_smi_monitor(unsigned int node, smm_state_save_area_t *state_save)
527 #define IOTRAP(x) (trap_sts & (1 << x))
528 u32 trap_sts, trap_cycle;
532 trap_sts = RCBA32(0x1e00); // TRSR - Trap Status Register
533 RCBA32(0x1e00) = trap_sts; // Clear trap(s) in TRSR
535 trap_cycle = RCBA32(0x1e10);
536 for (i=16; i<20; i++) {
537 if (trap_cycle & (1 << i))
538 mask |= (0xff << ((i - 16) << 2));
542 /* IOTRAP(3) SMI function call */
544 if (gnvs && gnvs->smif)
545 io_trap_handler(gnvs->smif); // call function smif
549 /* IOTRAP(2) currently unused
550 * IOTRAP(1) currently unused */
554 if (!(trap_cycle & (1 << 24))) { // It's a write
555 printk(BIOS_DEBUG, "SMI1 command\n");
556 data = RCBA32(0x1e18);
559 // southbridge_smi_command(data);
562 // Fall through to debug
565 printk(BIOS_DEBUG, " trapped io address = 0x%x\n", trap_cycle & 0xfffc);
566 for (i=0; i < 4; i++) if(IOTRAP(i)) printk(BIOS_DEBUG, " TRAPĀ = %d\n", i);
567 printk(BIOS_DEBUG, " AHBE = %x\n", (trap_cycle >> 16) & 0xf);
568 printk(BIOS_DEBUG, " MASK = 0x%08x\n", mask);
569 printk(BIOS_DEBUG, " read/write: %s\n", (trap_cycle & (1 << 24)) ? "read" : "write");
571 if (!(trap_cycle & (1 << 24))) {
573 data = RCBA32(0x1e18);
574 printk(BIOS_DEBUG, " iotrap written data = 0x%08x\n", data);
579 typedef void (*smi_handler_t)(unsigned int node,
580 smm_state_save_area_t *state_save);
582 smi_handler_t southbridge_smi[32] = {
583 NULL, // [0] reserved
584 NULL, // [1] reserved
585 NULL, // [2] BIOS_STS
586 NULL, // [3] LEGACY_USB_STS
587 southbridge_smi_sleep, // [4] SLP_SMI_STS
588 southbridge_smi_apmc, // [5] APM_STS
589 NULL, // [6] SWSMI_TMR_STS
590 NULL, // [7] reserved
591 southbridge_smi_pm1, // [8] PM1_STS
592 southbridge_smi_gpe0, // [9] GPE0_STS
593 southbridge_smi_gpi, // [10] GPI_STS
594 southbridge_smi_mc, // [11] MCSMI_STS
595 NULL, // [12] DEVMON_STS
596 southbridge_smi_tco, // [13] TCO_STS
597 southbridge_smi_periodic, // [14] PERIODIC_STS
598 NULL, // [15] SERIRQ_SMI_STS
599 NULL, // [16] SMBUS_SMI_STS
600 NULL, // [17] LEGACY_USB2_STS
601 NULL, // [18] INTEL_USB2_STS
602 NULL, // [19] reserved
603 NULL, // [20] PCI_EXP_SMI_STS
604 southbridge_smi_monitor, // [21] MONITOR_STS
605 NULL, // [22] reserved
606 NULL, // [23] reserved
607 NULL, // [24] reserved
608 NULL, // [25] EL_SMI_STS
609 NULL, // [26] SPI_STS
610 NULL, // [27] reserved
611 NULL, // [28] reserved
612 NULL, // [29] reserved
613 NULL, // [30] reserved
614 NULL // [31] reserved
618 * @brief Interrupt handler for SMI#
620 * @param smm_revision revision of the smm state save map
623 void southbridge_smi_handler(unsigned int node, smm_state_save_area_t *state_save)
628 /* Update global variable pmbase */
629 pmbase = pcie_read_config16(PCI_DEV(0, 0x1f, 0), 0x40) & 0xfffc;
631 /* We need to clear the SMI status registers, or we won't see what's
632 * happening in the following calls.
634 smi_sts = reset_smi_status();
636 /* Filter all non-enabled SMI events */
637 // FIXME Double check, this clears MONITOR
638 // smi_sts &= inl(pmbase + SMI_EN);
640 /* Call SMI sub handler for each of the status bits */
641 for (i = 0; i < 31; i++) {
642 if (smi_sts & (1 << i)) {
643 if (southbridge_smi[i])
644 southbridge_smi[i](node, state_save);
646 printk(BIOS_DEBUG, "SMI_STS[%d] occured, but no "
647 "handler available.\n", i);
654 dump_smi_status(smi_sts);