src/southbridge/intel/i82801gx/lpc.c

   1 /*
   2  * This file is part of the coreboot project.
   3  *
   4  * Copyright (C) 2008-2009 coresystems GmbH
   5  *
   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
   9  * the License.
  10  *
  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.
  15  *
  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, MA  02110-1301 USA
  19  */
  20
  21 #include <console/console.h>
  22 #include <device/device.h>
  23 #include <device/pci.h>
  24 #include <device/pci_ids.h>
  25 #include <pc80/mc146818rtc.h>
  26 #include <pc80/isa-dma.h>
  27 #include <pc80/i8259.h>
  28 #include <arch/io.h>
  29 #include <arch/ioapic.h>
  30 #include <arch/acpi.h>
  31 #include <cpu/cpu.h>
  32 #include "i82801gx.h"
  33 #include <cpu/x86/smm.h>
  34
  35 #define NMI_OFF 0
  36
  37 #define ENABLE_ACPI_MODE_IN_COREBOOT    0
  38 #define TEST_SMM_FLASH_LOCKDOWN         0
  39
  40 typedef struct southbridge_intel_i82801gx_config config_t;
  41
  42 static void i82801gx_enable_apic(struct device *dev)
  43 {
  44         int i;
  45         u32 reg32;
  46         volatile u32 *ioapic_index = (volatile u32 *)(IO_APIC_ADDR);
  47         volatile u32 *ioapic_data = (volatile u32 *)(IO_APIC_ADDR + 0x10);
  48
  49         /* Enable ACPI I/O and power management.
  50          * Set SCI IRQ to IRQ9
  51          */
  52         pci_write_config8(dev, ACPI_CNTL, 0x80);
  53
  54         *ioapic_index = 0;
  55         *ioapic_data = (1 << 25);
  56
  57         *ioapic_index = 0;
  58         reg32 = *ioapic_data;
  59         printk(BIOS_DEBUG, "Southbridge APIC ID = %x\n", (reg32 >> 24) & 0x0f);
  60         if (reg32 != (1 << 25))
  61                 die("APIC Error\n");
  62
  63         printk(BIOS_SPEW, "Dumping IOAPIC registers\n");
  64         for (i=0; i<3; i++) {
  65                 *ioapic_index = i;
  66                 printk(BIOS_SPEW, "  reg 0x%04x:", i);
  67                 reg32 = *ioapic_data;
  68                 printk(BIOS_SPEW, " 0x%08x\n", reg32);
  69         }
  70
  71         *ioapic_index = 3; /* Select Boot Configuration register. */
  72         *ioapic_data = 1; /* Use Processor System Bus to deliver interrupts. */
  73 }
  74
  75 static void i82801gx_enable_serial_irqs(struct device *dev)
  76 {
  77         /* Set packet length and toggle silent mode bit for one frame. */
  78         pci_write_config8(dev, SERIRQ_CNTL,
  79                           (1 << 7) | (1 << 6) | ((21 - 17) << 2) | (0 << 0));
  80 }
  81
  82 /* PIRQ[n]_ROUT[3:0] - PIRQ Routing Control
  83  * 0x00 - 0000 = Reserved
  84  * 0x01 - 0001 = Reserved
  85  * 0x02 - 0010 = Reserved
  86  * 0x03 - 0011 = IRQ3
  87  * 0x04 - 0100 = IRQ4
  88  * 0x05 - 0101 = IRQ5
  89  * 0x06 - 0110 = IRQ6
  90  * 0x07 - 0111 = IRQ7
  91  * 0x08 - 1000 = Reserved
  92  * 0x09 - 1001 = IRQ9
  93  * 0x0A - 1010 = IRQ10
  94  * 0x0B - 1011 = IRQ11
  95  * 0x0C - 1100 = IRQ12
  96  * 0x0D - 1101 = Reserved
  97  * 0x0E - 1110 = IRQ14
  98  * 0x0F - 1111 = IRQ15
  99  * PIRQ[n]_ROUT[7] - PIRQ Routing Control
 100  * 0x80 - The PIRQ is not routed.
 101  */
 102
 103 static void i82801gx_pirq_init(device_t dev)
 104 {
 105         device_t irq_dev;
 106         /* Get the chip configuration */
 107         config_t *config = dev->chip_info;
 108
 109         pci_write_config8(dev, PIRQA_ROUT, config->pirqa_routing);
 110         pci_write_config8(dev, PIRQB_ROUT, config->pirqb_routing);
 111         pci_write_config8(dev, PIRQC_ROUT, config->pirqc_routing);
 112         pci_write_config8(dev, PIRQD_ROUT, config->pirqd_routing);
 113
 114         pci_write_config8(dev, PIRQE_ROUT, config->pirqe_routing);
 115         pci_write_config8(dev, PIRQF_ROUT, config->pirqf_routing);
 116         pci_write_config8(dev, PIRQG_ROUT, config->pirqg_routing);
 117         pci_write_config8(dev, PIRQH_ROUT, config->pirqh_routing);
 118
 119         /* Eric Biederman once said we should let the OS do this.
 120          * I am not so sure anymore he was right.
 121          */
 122
 123         for(irq_dev = all_devices; irq_dev; irq_dev = irq_dev->next) {
 124                 u8 int_pin=0, int_line=0;
 125
 126                 if (!irq_dev->enabled || irq_dev->path.type != DEVICE_PATH_PCI)
 127                         continue;
 128
 129                 int_pin = pci_read_config8(irq_dev, PCI_INTERRUPT_PIN);
 130
 131                 switch (int_pin) {
 132                 case 1: /* INTA# */ int_line = config->pirqa_routing; break;
 133                 case 2: /* INTB# */ int_line = config->pirqb_routing; break;
 134                 case 3: /* INTC# */ int_line = config->pirqc_routing; break;
 135                 case 4: /* INTD# */ int_line = config->pirqd_routing; break;
 136                 }
 137
 138                 if (!int_line)
 139                         continue;
 140
 141                 pci_write_config8(irq_dev, PCI_INTERRUPT_LINE, int_line);
 142         }
 143 }
 144
 145 static void i82801gx_gpi_routing(device_t dev)
 146 {
 147         /* Get the chip configuration */
 148         config_t *config = dev->chip_info;
 149         u32 reg32 = 0;
 150
 151         /* An array would be much nicer here, or some
 152          * other method of doing this.
 153          */
 154         reg32 |= (config->gpi0_routing & 0x03) << 0;
 155         reg32 |= (config->gpi1_routing & 0x03) << 2;
 156         reg32 |= (config->gpi2_routing & 0x03) << 4;
 157         reg32 |= (config->gpi3_routing & 0x03) << 6;
 158         reg32 |= (config->gpi4_routing & 0x03) << 8;
 159         reg32 |= (config->gpi5_routing & 0x03) << 10;
 160         reg32 |= (config->gpi6_routing & 0x03) << 12;
 161         reg32 |= (config->gpi7_routing & 0x03) << 14;
 162         reg32 |= (config->gpi8_routing & 0x03) << 16;
 163         reg32 |= (config->gpi9_routing & 0x03) << 18;
 164         reg32 |= (config->gpi10_routing & 0x03) << 20;
 165         reg32 |= (config->gpi11_routing & 0x03) << 22;
 166         reg32 |= (config->gpi12_routing & 0x03) << 24;
 167         reg32 |= (config->gpi13_routing & 0x03) << 26;
 168         reg32 |= (config->gpi14_routing & 0x03) << 28;
 169         reg32 |= (config->gpi15_routing & 0x03) << 30;
 170
 171         pci_write_config32(dev, 0xb8, reg32);
 172 }
 173
 174 static void i82801gx_power_options(device_t dev)
 175 {
 176         u8 reg8;
 177         u16 reg16, pmbase;
 178         u32 reg32;
 179         const char *state;
 180         /* Get the chip configuration */
 181         config_t *config = dev->chip_info;
 182
 183         int pwr_on=CONFIG_MAINBOARD_POWER_ON_AFTER_POWER_FAIL;
 184         int nmi_option;
 185
 186         /* Which state do we want to goto after g3 (power restored)?
 187          * 0 == S0 Full On
 188          * 1 == S5 Soft Off
 189          *
 190          * If the option is not existent (Laptops), use MAINBOARD_POWER_ON.
 191          */
 192         if (get_option(&pwr_on, "power_on_after_fail") < 0)
 193                 pwr_on = MAINBOARD_POWER_ON;
 194
 195         reg8 = pci_read_config8(dev, GEN_PMCON_3);
 196         reg8 &= 0xfe;
 197         switch (pwr_on) {
 198         case MAINBOARD_POWER_OFF:
 199                 reg8 |= 1;
 200                 state = "off";
 201                 break;
 202         case MAINBOARD_POWER_ON:
 203                 reg8 &= ~1;
 204                 state = "on";
 205                 break;
 206         case MAINBOARD_POWER_KEEP:
 207                 reg8 &= ~1;
 208                 state = "state keep";
 209                 break;
 210         default:
 211                 state = "undefined";
 212         }
 213
 214         reg8 |= (3 << 4);       /* avoid #S4 assertions */
 215         reg8 &= ~(1 << 3);      /* minimum asssertion is 1 to 2 RTCCLK */
 216
 217         pci_write_config8(dev, GEN_PMCON_3, reg8);
 218         printk(BIOS_INFO, "Set power %s after power failure.\n", state);
 219
 220         /* Set up NMI on errors. */
 221         reg8 = inb(0x61);
 222         reg8 &= 0x0f;           /* Higher Nibble must be 0 */
 223         reg8 &= ~(1 << 3);      /* IOCHK# NMI Enable */
 224         // reg8 &= ~(1 << 2);   /* PCI SERR# Enable */
 225         reg8 |= (1 << 2); /* PCI SERR# Disable for now */
 226         outb(reg8, 0x61);
 227
 228         reg8 = inb(0x70);
 229         nmi_option = NMI_OFF;
 230         get_option(&nmi_option, "nmi");
 231         if (nmi_option) {
 232                 printk(BIOS_INFO, "NMI sources enabled.\n");
 233                 reg8 &= ~(1 << 7);      /* Set NMI. */
 234         } else {
 235                 printk(BIOS_INFO, "NMI sources disabled.\n");
 236                 reg8 |= ( 1 << 7);      /* Can't mask NMI from PCI-E and NMI_NOW */
 237         }
 238         outb(reg8, 0x70);
 239
 240         /* Enable CPU_SLP# and Intel Speedstep, set SMI# rate down */
 241         reg16 = pci_read_config16(dev, GEN_PMCON_1);
 242         reg16 &= ~(3 << 0);     // SMI# rate 1 minute
 243         reg16 |= (1 << 2);      // CLKRUN_EN - Mobile/Ultra only
 244         reg16 |= (1 << 3);      // Speedstep Enable - Mobile/Ultra only
 245         reg16 |= (1 << 5);      // CPUSLP_EN Desktop only
 246
 247         if (config->c4onc3_enable)
 248                 reg16 |= (1 << 7);
 249
 250         // another laptop wants this?
 251         // reg16 &= ~(1 << 10); // BIOS_PCI_EXP_EN - Desktop/Mobile only
 252         reg16 |= (1 << 10);     // BIOS_PCI_EXP_EN - Desktop/Mobile only
 253 #if DEBUG_PERIODIC_SMIS
 254         /* Set DEBUG_PERIODIC_SMIS in i82801gx.h to debug using
 255          * periodic SMIs.
 256          */
 257         reg16 |= (3 << 0); // Periodic SMI every 8s
 258 #endif
 259         pci_write_config16(dev, GEN_PMCON_1, reg16);
 260
 261         // Set the board's GPI routing.
 262         i82801gx_gpi_routing(dev);
 263
 264         pmbase = pci_read_config16(dev, 0x40) & 0xfffe;
 265
 266         outl(config->gpe0_en, pmbase + GPE0_EN);
 267         outw(config->alt_gp_smi_en, pmbase + ALT_GP_SMI_EN);
 268
 269         /* Set up power management block and determine sleep mode */
 270         reg32 = inl(pmbase + 0x04); // PM1_CNT
 271
 272         reg32 &= ~(7 << 10);    // SLP_TYP
 273         reg32 |= (1 << 1);      // enable C3->C0 transition on bus master
 274         reg32 |= (1 << 0);      // SCI_EN
 275         outl(reg32, pmbase + 0x04);
 276 }
 277
 278 static void i82801gx_configure_cstates(device_t dev)
 279 {
 280         u8 reg8;
 281
 282         reg8 = pci_read_config8(dev, 0xa9); // Cx state configuration
 283         reg8 |= (1 << 4) | (1 << 3) | (1 << 2); // Enable Popup & Popdown
 284         pci_write_config8(dev, 0xa9, reg8);
 285
 286         // Set Deeper Sleep configuration to recommended values
 287         reg8 = pci_read_config8(dev, 0xaa);
 288         reg8 &= 0xf0;
 289         reg8 |= (2 << 2);       // Deeper Sleep to Stop CPU: 34-40us
 290         reg8 |= (2 << 0);       // Deeper Sleep to Sleep: 15us
 291         pci_write_config8(dev, 0xaa, reg8);
 292 }
 293
 294 static void i82801gx_rtc_init(struct device *dev)
 295 {
 296         u8 reg8;
 297         int rtc_failed;
 298
 299         reg8 = pci_read_config8(dev, GEN_PMCON_3);
 300         rtc_failed = reg8 & RTC_BATTERY_DEAD;
 301         if (rtc_failed) {
 302                 reg8 &= ~RTC_BATTERY_DEAD;
 303                 pci_write_config8(dev, GEN_PMCON_3, reg8);
 304         }
 305         printk(BIOS_DEBUG, "rtc_failed = 0x%x\n", rtc_failed);
 306
 307         rtc_init(rtc_failed);
 308 }
 309
 310 static void enable_hpet(void)
 311 {
 312         u32 reg32;
 313
 314         /* Move HPET to default address 0xfed00000 and enable it */
 315         reg32 = RCBA32(HPTC);
 316         reg32 |= (1 << 7); // HPET Address Enable
 317         reg32 &= ~(3 << 0);
 318         RCBA32(HPTC) = reg32;
 319 }
 320
 321 static void enable_clock_gating(void)
 322 {
 323         u32 reg32;
 324
 325         /* Enable Clock Gating for most devices */
 326         reg32 = RCBA32(CG);
 327         reg32 |= (1 << 31);     // LPC clock gating
 328         reg32 |= (1 << 30);     // PATA clock gating
 329         // SATA clock gating
 330         reg32 |= (1 << 27) | (1 << 26) | (1 << 25) | (1 << 24);
 331         reg32 |= (1 << 23);     // AC97 clock gating
 332         reg32 |= (1 << 19);     // USB EHCI clock gating
 333         reg32 |= (1 << 3) | (1 << 1);   // DMI clock gating
 334         reg32 |= (1 << 2);      // PCIe clock gating;
 335         reg32 &= ~(1 << 20); // No static clock gating for USB
 336         reg32 &= ~( (1 << 29) | (1 << 28) ); // Disable UHCI clock gating
 337         RCBA32(CG) = reg32;
 338 }
 339
 340 #if CONFIG_HAVE_SMI_HANDLER
 341 static void i82801gx_lock_smm(struct device *dev)
 342 {
 343 #if TEST_SMM_FLASH_LOCKDOWN
 344         u8 reg8;
 345 #endif
 346
 347         if (acpi_slp_type != 3) {
 348 #if ENABLE_ACPI_MODE_IN_COREBOOT
 349                 printk(BIOS_DEBUG, "Enabling ACPI via APMC:\n");
 350                 outb(APM_CNT_ACPI_ENABLE, APM_CNT); // Enable ACPI mode
 351                 printk(BIOS_DEBUG, "done.\n");
 352 #else
 353                 printk(BIOS_DEBUG, "Disabling ACPI via APMC:\n");
 354                 outb(APM_CNT_ACPI_DISABLE, APM_CNT); // Disable ACPI mode
 355                 printk(BIOS_DEBUG, "done.\n");
 356 #endif
 357         } else {
 358                 printk(BIOS_DEBUG, "S3 wakeup, enabling ACPI via APMC\n");
 359                 outb(APM_CNT_ACPI_ENABLE, APM_CNT);
 360         }
 361         /* Don't allow evil boot loaders, kernels, or
 362          * userspace applications to deceive us:
 363          */
 364         smm_lock();
 365
 366 #if TEST_SMM_FLASH_LOCKDOWN
 367         /* Now try this: */
 368         printk(BIOS_DEBUG, "Locking BIOS to RO... ");
 369         reg8 = pci_read_config8(dev, 0xdc);     /* BIOS_CNTL */
 370         printk(BIOS_DEBUG, " BLE: %s; BWE: %s\n", (reg8&2)?"on":"off",
 371                         (reg8&1)?"rw":"ro");
 372         reg8 &= ~(1 << 0);                      /* clear BIOSWE */
 373         pci_write_config8(dev, 0xdc, reg8);
 374         reg8 |= (1 << 1);                       /* set BLE */
 375         pci_write_config8(dev, 0xdc, reg8);
 376         printk(BIOS_DEBUG, "ok.\n");
 377         reg8 = pci_read_config8(dev, 0xdc);     /* BIOS_CNTL */
 378         printk(BIOS_DEBUG, " BLE: %s; BWE: %s\n", (reg8&2)?"on":"off",
 379                         (reg8&1)?"rw":"ro");
 380
 381         printk(BIOS_DEBUG, "Writing:\n");
 382         *(volatile u8 *)0xfff00000 = 0x00;
 383         printk(BIOS_DEBUG, "Testing:\n");
 384         reg8 |= (1 << 0);                       /* set BIOSWE */
 385         pci_write_config8(dev, 0xdc, reg8);
 386
 387         reg8 = pci_read_config8(dev, 0xdc);     /* BIOS_CNTL */
 388         printk(BIOS_DEBUG, " BLE: %s; BWE: %s\n", (reg8&2)?"on":"off",
 389                         (reg8&1)?"rw":"ro");
 390         printk(BIOS_DEBUG, "Done.\n");
 391 #endif
 392 }
 393 #endif
 394
 395 #define SPIBASE 0x3020
 396 static void i82801gx_spi_init(void)
 397 {
 398         u16 spicontrol;
 399
 400         spicontrol = RCBA16(SPIBASE + 2);
 401         spicontrol &= ~(1 << 0); // SPI Access Request
 402         RCBA16(SPIBASE + 2) = spicontrol;
 403 }
 404
 405 static void i82801gx_fixups(struct device *dev)
 406 {
 407         /* This needs to happen after PCI enumeration */
 408         RCBA32(0x1d40) |= 1;
 409
 410         /* USB Transient Disconnect Detect:
 411          * Prevent a SE0 condition on the USB ports from being
 412          * interpreted by the UHCI controller as a disconnect
 413          */
 414         pci_write_config8(dev, 0xad, 0x3);
 415 }
 416
 417 static void lpc_init(struct device *dev)
 418 {
 419         printk(BIOS_DEBUG, "i82801gx: lpc_init\n");
 420
 421         /* Set the value for PCI command register. */
 422         pci_write_config16(dev, PCI_COMMAND, 0x000f);
 423
 424         /* IO APIC initialization. */
 425         i82801gx_enable_apic(dev);
 426
 427         i82801gx_enable_serial_irqs(dev);
 428
 429         /* Setup the PIRQ. */
 430         i82801gx_pirq_init(dev);
 431
 432         /* Setup power options. */
 433         i82801gx_power_options(dev);
 434
 435         /* Configure Cx state registers */
 436         i82801gx_configure_cstates(dev);
 437
 438         /* Set the state of the GPIO lines. */
 439         //gpio_init(dev);
 440
 441         /* Initialize the real time clock. */
 442         i82801gx_rtc_init(dev);
 443
 444         /* Initialize ISA DMA. */
 445         isa_dma_init();
 446
 447         /* Initialize the High Precision Event Timers, if present. */
 448         enable_hpet();
 449
 450         /* Initialize Clock Gating */
 451         enable_clock_gating();
 452
 453         setup_i8259();
 454
 455         /* The OS should do this? */
 456         /* Interrupt 9 should be level triggered (SCI) */
 457         i8259_configure_irq_trigger(9, 1);
 458
 459 #if CONFIG_HAVE_SMI_HANDLER
 460         i82801gx_lock_smm(dev);
 461 #endif
 462
 463         i82801gx_spi_init();
 464
 465         i82801gx_fixups(dev);
 466 }
 467
 468 static void i82801gx_lpc_read_resources(device_t dev)
 469 {
 470         struct resource *res;
 471
 472         /* Get the normal PCI resources of this device. */
 473         pci_dev_read_resources(dev);
 474
 475         /* Add an extra subtractive resource for both memory and I/O. */
 476         res = new_resource(dev, IOINDEX_SUBTRACTIVE(0, 0));
 477         res->base = 0;
 478         res->size = 0x1000;
 479         res->flags = IORESOURCE_IO | IORESOURCE_SUBTRACTIVE |
 480                      IORESOURCE_ASSIGNED | IORESOURCE_FIXED;
 481
 482         res = new_resource(dev, IOINDEX_SUBTRACTIVE(1, 0));
 483         res->base = 0xff800000;
 484         res->size = 0x00800000; /* 8 MB for flash */
 485         res->flags = IORESOURCE_MEM | IORESOURCE_SUBTRACTIVE |
 486                      IORESOURCE_ASSIGNED | IORESOURCE_FIXED;
 487
 488         res = new_resource(dev, 3); /* IOAPIC */
 489         res->base = IO_APIC_ADDR;
 490         res->size = 0x00001000;
 491         res->flags = IORESOURCE_MEM | IORESOURCE_ASSIGNED | IORESOURCE_FIXED;
 492 }
 493
 494 static void set_subsystem(device_t dev, unsigned vendor, unsigned device)
 495 {
 496         if (!vendor || !device) {
 497                 pci_write_config32(dev, PCI_SUBSYSTEM_VENDOR_ID,
 498                                 pci_read_config32(dev, PCI_VENDOR_ID));
 499         } else {
 500                 pci_write_config32(dev, PCI_SUBSYSTEM_VENDOR_ID,
 501                                 ((device & 0xffff) << 16) | (vendor & 0xffff));
 502         }
 503 }
 504
 505 static struct pci_operations pci_ops = {
 506         .set_subsystem = set_subsystem,
 507 };
 508
 509 static struct device_operations device_ops = {
 510         .read_resources         = i82801gx_lpc_read_resources,
 511         .set_resources          = pci_dev_set_resources,
 512         .enable_resources       = pci_dev_enable_resources,
 513         .init                   = lpc_init,
 514         .scan_bus               = scan_static_bus,
 515         .enable                 = i82801gx_enable,
 516         .ops_pci                = &pci_ops,
 517 };
 518
 519 /* 82801GH (ICH7 DH) */
 520 static const struct pci_driver ich7_dh_lpc __pci_driver = {
 521         .ops    = &device_ops,
 522         .vendor = PCI_VENDOR_ID_INTEL,
 523         .device = 0x27b0,
 524 };
 525
 526 /* 82801GB/GR (ICH7/ICH7R) */
 527 static const struct pci_driver ich7_ich7r_lpc __pci_driver = {
 528         .ops    = &device_ops,
 529         .vendor = PCI_VENDOR_ID_INTEL,
 530         .device = 0x27b8,
 531 };
 532
 533 /* 82801GBM/GU (ICH7-M/ICH7-U) */
 534 static const struct pci_driver ich7m_ich7u_lpc __pci_driver = {
 535         .ops    = &device_ops,
 536         .vendor = PCI_VENDOR_ID_INTEL,
 537         .device = 0x27b9,
 538 };
 539
 540 /* 82801GHM (ICH7-M DH) */
 541 static const struct pci_driver ich7m_dh_lpc __pci_driver = {
 542         .ops    = &device_ops,
 543         .vendor = PCI_VENDOR_ID_INTEL,
 544         .device = 0x27bd,
 545 };