This patch aims to restructure SPI flash support in a more reasonable
[coreboot.git] / util / flashrom / chipset_enable.c
index d49d08541ff1cf082e173043afb30fcc6df2603e..8a4fd56f51bec954643d1268f6641f32685b76ea 100644 (file)
@@ -1,35 +1,56 @@
 /*
- *   flash rom utility: enable flash writes
+ * This file is part of the flashrom project.
  *
- *   Copyright (C) 2000 Silicon Integrated System Corporation
- *   Copyright (C) 2005-2007 coresystems GmbH <stepan@coresystems.de>
- *   Copyright (C) 2006 Uwe Hermann <uwe@hermann-uwe.de>
+ * Copyright (C) 2000 Silicon Integrated System Corporation
+ * Copyright (C) 2005-2007 coresystems GmbH <stepan@coresystems.de>
+ * Copyright (C) 2006 Uwe Hermann <uwe@hermann-uwe.de>
  *
- *   This program is free software; you can redistribute it and/or
- *   modify it under the terms of the GNU General Public License
- *   version 2
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 2 of the License.
  *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+ */
+
+/*
+ * Contains the chipset specific flash enables.
  */
 
 #include <stdio.h>
 #include <pci/pci.h>
 #include <stdlib.h>
-
 #include "flash.h"
-#include "debug.h"
+
+static int enable_flash_ali_m1533(struct pci_dev *dev, char *name)
+{
+       uint8_t tmp;
+
+       /* ROM Write enable, 0xFFFC0000-0xFFFDFFFF and
+          0xFFFE0000-0xFFFFFFFF ROM select enable. */
+       tmp = pci_read_byte(dev, 0x47);
+       tmp |= 0x46;
+       pci_write_byte(dev, 0x47, tmp);
+
+       return 0;
+}
 
 static int enable_flash_sis630(struct pci_dev *dev, char *name)
 {
        char b;
 
        /* Enable 0xFFF8000~0xFFFF0000 decoding on SiS 540/630 */
-       outl(0x80000840, 0x0cf8);
-       b = inb(0x0cfc) | 0x0b;
-       outb(b, 0xcfc);
+       b = pci_read_byte(dev, 0x40);
+       pci_write_byte(dev, 0x40, b | 0xb);
        /* Flash write enable on SiS 540/630 */
-       outl(0x80000845, 0x0cf8);
-       b = inb(0x0cfd) | 0x40;
-       outb(b, 0xcfd);
+       b = pci_read_byte(dev, 0x45);
+       pci_write_byte(dev, 0x45, b | 0x40);
 
        /* The same thing on SiS 950 SuperIO side */
        outb(0x87, 0x2e);
@@ -75,20 +96,21 @@ static int enable_flash_sis630(struct pci_dev *dev, char *name)
 static int enable_flash_piix4(struct pci_dev *dev, char *name)
 {
        uint16_t old, new;
-       uint16_t xbcs = 0x4e; /* X-Bus Chip Select register. */
+       uint16_t xbcs = 0x4e;   /* X-Bus Chip Select register. */
 
        old = pci_read_word(dev, xbcs);
 
        /* Set bit 9: 1-Meg Extended BIOS Enable (PCI master accesses to
-                      FFF00000-FFF7FFFF are forwarded to ISA).
-           Set bit 7: Extended BIOS Enable (PCI master accesses to
-                      FFF80000-FFFDFFFF are forwarded to ISA).
-           Set bit 6: Lower BIOS Enable (PCI master, or ISA master accesses to
-                      the lower 64-Kbyte BIOS block (E0000-EFFFF) at the top
-                      of 1 Mbyte, or the aliases at the top of 4 Gbyte
-                      (FFFE0000-FFFEFFFF) result in the generation of BIOSCS#.
-           Note: Accesses to FFFF0000-FFFFFFFF are always forwarded to ISA.
-           Set bit 2: BIOSCS# Write Enable (1=enable, 0=disable). */
+        *            FFF00000-FFF7FFFF are forwarded to ISA).
+        * Set bit 7: Extended BIOS Enable (PCI master accesses to
+        *            FFF80000-FFFDFFFF are forwarded to ISA).
+        * Set bit 6: Lower BIOS Enable (PCI master, or ISA master accesses to
+        *            the lower 64-Kbyte BIOS block (E0000-EFFFF) at the top
+        *            of 1 Mbyte, or the aliases at the top of 4 Gbyte
+        *            (FFFE0000-FFFEFFFF) result in the generation of BIOSCS#.
+        * Note: Accesses to FFFF0000-FFFFFFFF are always forwarded to ISA.
+        * Set bit 2: BIOSCS# Write Enable (1=enable, 0=disable).
+        */
        new = old | 0x2c4;
 
        if (new == old)
@@ -100,6 +122,7 @@ static int enable_flash_piix4(struct pci_dev *dev, char *name)
                printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n", xbcs, new, name);
                return -1;
        }
+
        return 0;
 }
 
@@ -113,7 +136,7 @@ static int enable_flash_ich(struct pci_dev *dev, char *name, int bios_cntl)
         */
 
        /* Note: the ICH0-ICH5 BIOS_CNTL register is actually 16 bit wide, but
-         * just treating it as 8 bit wide seems to work fine in practice.
+        * just treating it as 8 bit wide seems to work fine in practice.
         */
 
        /* see ie. page 375 of "Intel ICH7 External Design Specification"
@@ -130,10 +153,10 @@ static int enable_flash_ich(struct pci_dev *dev, char *name, int bios_cntl)
        pci_write_byte(dev, bios_cntl, new);
 
        if (pci_read_byte(dev, bios_cntl) != new) {
-               printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                      bios_cntl, new, name);
+               printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n", bios_cntl, new, name);
                return -1;
        }
+
        return 0;
 }
 
@@ -147,49 +170,54 @@ static int enable_flash_ich_dc(struct pci_dev *dev, char *name)
        return enable_flash_ich(dev, name, 0xdc);
 }
 
-/*
- *
- */
-static int
-enable_flash_vt823x(struct pci_dev *dev, char *name)
+static int enable_flash_vt823x(struct pci_dev *dev, char *name)
 {
        uint8_t val;
 
-        /* ROM Write enable */
+       /* ROM write enable */
        val = pci_read_byte(dev, 0x40);
        val |= 0x10;
        pci_write_byte(dev, 0x40, val);
 
        if (pci_read_byte(dev, 0x40) != val) {
                printf("\nWARNING: Failed to enable ROM Write on \"%s\"\n",
-                       name);
+                      name);
                return -1;
        }
 
-        return 0;
+       return 0;
 }
 
 static int enable_flash_cs5530(struct pci_dev *dev, char *name)
 {
-       uint8_t new;
+       uint8_t reg8;
 
-       pci_write_byte(dev, 0x52, 0xee);
+       #define DECODE_CONTROL_REG2             0x5b    /* F0 index 0x5b */
+       #define ROM_AT_LOGIC_CONTROL_REG        0x52    /* F0 index 0x52 */
 
-       new = pci_read_byte(dev, 0x52);
+       #define LOWER_ROM_ADDRESS_RANGE         (1 << 0)
+       #define ROM_WRITE_ENABLE                (1 << 1)
+       #define UPPER_ROM_ADDRESS_RANGE         (1 << 2)
+       #define BIOS_ROM_POSITIVE_DECODE        (1 << 5)
 
-       if (new != 0xee) {
-               printf("tried to set register 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                      0x52, new, name);
-               return -1;
-       }
+       /* Decode 0x000E0000-0x000FFFFF (128 KB), not just 64 KB, and
+        * decode 0xFF000000-0xFFFFFFFF (16 MB), not just 256 KB.
+        * Make the configured ROM areas writable.
+        */
+       reg8 = pci_read_byte(dev, ROM_AT_LOGIC_CONTROL_REG);
+       reg8 |= LOWER_ROM_ADDRESS_RANGE;
+       reg8 |= UPPER_ROM_ADDRESS_RANGE;
+       reg8 |= ROM_WRITE_ENABLE;
+       pci_write_byte(dev, ROM_AT_LOGIC_CONTROL_REG, reg8);
 
-       new = pci_read_byte(dev, 0x5b) | 0x20;
-       pci_write_byte(dev, 0x5b, new);
+       /* Set positive decode on ROM. */
+       reg8 = pci_read_byte(dev, DECODE_CONTROL_REG2);
+       reg8 |= BIOS_ROM_POSITIVE_DECODE;
+       pci_write_byte(dev, DECODE_CONTROL_REG2, reg8);
 
        return 0;
 }
 
-
 static int enable_flash_sc1100(struct pci_dev *dev, char *name)
 {
        uint8_t new;
@@ -199,10 +227,10 @@ static int enable_flash_sc1100(struct pci_dev *dev, char *name)
        new = pci_read_byte(dev, 0x52);
 
        if (new != 0xee) {
-               printf("tried to set register 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                      0x52, new, name);
+               printf("tried to set register 0x%x to 0x%x on %s failed (WARNING ONLY)\n", 0x52, new, name);
                return -1;
        }
+
        return 0;
 }
 
@@ -221,11 +249,11 @@ static int enable_flash_sis5595(struct pci_dev *dev, char *name)
 
        newer = pci_read_byte(dev, 0x45);
        if (newer != new) {
-               printf("tried to set register 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                      0x45, new, name);
+               printf("tried to set register 0x%x to 0x%x on %s failed (WARNING ONLY)\n", 0x45, new, name);
                printf("Stuck at 0x%x\n", newer);
                return -1;
        }
+
        return 0;
 }
 
@@ -233,6 +261,7 @@ static int enable_flash_amd8111(struct pci_dev *dev, char *name)
 {
        /* register 4e.b gets or'ed with one */
        uint8_t old, new;
+
        /* if it fails, it fails. There are so many variations of broken mobos
         * that it is hard to argue that we should quit at this point.
         */
@@ -243,8 +272,7 @@ static int enable_flash_amd8111(struct pci_dev *dev, char *name)
        if (new != old) {
                pci_write_byte(dev, 0x43, new);
                if (pci_read_byte(dev, 0x43) != new) {
-                       printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                              0x43, new, name);
+                       printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n", 0x43, new, name);
                }
        }
 
@@ -255,56 +283,56 @@ static int enable_flash_amd8111(struct pci_dev *dev, char *name)
        pci_write_byte(dev, 0x40, new);
 
        if (pci_read_byte(dev, 0x40) != new) {
-               printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                      0x40, new, name);
+               printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n", 0x40, new, name);
                return -1;
        }
+
        return 0;
 }
 
 static int enable_flash_ck804(struct pci_dev *dev, char *name)
 {
-        /* register 4e.b gets or'ed with one */
-        uint8_t old, new;
-        /* if it fails, it fails. There are so many variations of broken mobos
-         * that it is hard to argue that we should quit at this point.
-         */
-
-        /* dump_pci_device(dev); */
-
-        old = pci_read_byte(dev, 0x88);
-        new = old | 0xc0;
-        if (new != old) {
-                pci_write_byte(dev, 0x88, new);
-                if (pci_read_byte(dev, 0x88) != new) {
-                        printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                               0x88, new, name);
-                }
-        }
-
-        old = pci_read_byte(dev, 0x6d);
-        new = old | 0x01;
-        if (new == old)
-                return 0;
-        pci_write_byte(dev, 0x6d, new);
-
-        if (pci_read_byte(dev, 0x6d) != new) {
-                printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                       0x6d, new, name);
-                return -1;
-        }
-        return 0;
+       /* register 4e.b gets or'ed with one */
+       uint8_t old, new;
+
+       /* if it fails, it fails. There are so many variations of broken mobos
+        * that it is hard to argue that we should quit at this point.
+        */
+
+       /* dump_pci_device(dev); */
+
+       old = pci_read_byte(dev, 0x88);
+       new = old | 0xc0;
+       if (new != old) {
+               pci_write_byte(dev, 0x88, new);
+               if (pci_read_byte(dev, 0x88) != new) {
+                       printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n", 0x88, new, name);
+               }
+       }
+
+       old = pci_read_byte(dev, 0x6d);
+       new = old | 0x01;
+       if (new == old)
+               return 0;
+       pci_write_byte(dev, 0x6d, new);
+
+       if (pci_read_byte(dev, 0x6d) != new) {
+               printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n", 0x6d, new, name);
+               return -1;
+       }
+
+       return 0;
 }
 
 static int enable_flash_sb400(struct pci_dev *dev, char *name)
 {
-        uint8_t tmp;
+       uint8_t tmp;
 
        struct pci_filter f;
        struct pci_dev *smbusdev;
 
        /* then look for the smbus device */
-       pci_filter_init((struct pci_access *) 0, &f);
+       pci_filter_init((struct pci_access *)0, &f);
        f.vendor = 0x1002;
        f.device = 0x4372;
 
@@ -314,26 +342,26 @@ static int enable_flash_sb400(struct pci_dev *dev, char *name)
                }
        }
 
-       if(!smbusdev) {
+       if (!smbusdev) {
                fprintf(stderr, "ERROR: SMBus device not found. aborting\n");
                exit(1);
        }
 
        /* enable some smbus stuff */
-       tmp=pci_read_byte(smbusdev, 0x79);
-       tmp|=0x01;
+       tmp = pci_read_byte(smbusdev, 0x79);
+       tmp |= 0x01;
        pci_write_byte(smbusdev, 0x79, tmp);
 
        /* change southbridge */
-       tmp=pci_read_byte(dev, 0x48);
-       tmp|=0x21;
+       tmp = pci_read_byte(dev, 0x48);
+       tmp |= 0x21;
        pci_write_byte(dev, 0x48, tmp);
 
        /* now become a bit silly. */
-       tmp=inb(0xc6f);
-       outb(tmp,0xeb);
+       tmp = inb(0xc6f);
+       outb(tmp, 0xeb);
        outb(tmp, 0xeb);
-       tmp|=0x40;
+       tmp |= 0x40;
        outb(tmp, 0xc6f);
        outb(tmp, 0xeb);
        outb(tmp, 0xeb);
@@ -343,41 +371,57 @@ static int enable_flash_sb400(struct pci_dev *dev, char *name)
 
 static int enable_flash_mcp55(struct pci_dev *dev, char *name)
 {
-        /* register 4e.b gets or'ed with one */
-        unsigned char old, new, byte;
-        unsigned short word;
-
-        /* if it fails, it fails. There are so many variations of broken mobos
-         * that it is hard to argue that we should quit at this point.
-         */
-
-        /* dump_pci_device(dev); */
-
-        /* Set the 4MB enable bit bit */
-        byte = pci_read_byte(dev, 0x88);
-        byte |= 0xff; /* 256K */
-        pci_write_byte(dev, 0x88, byte);
-        byte = pci_read_byte(dev, 0x8c);
-        byte |= 0xff; /* 1M */
-        pci_write_byte(dev, 0x8c, byte);
-        word = pci_read_word(dev, 0x90);
-        word |= 0x7fff; /* 15M */
-        pci_write_word(dev, 0x90, word);
-
-        old = pci_read_byte(dev, 0x6d);
-        new = old | 0x01;
-        if (new == old)
-                return 0;
-        pci_write_byte(dev, 0x6d, new);
-
-        if (pci_read_byte(dev, 0x6d) != new) {
-                printf("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
-                       0x6d, new, name);
-                return -1;
-        }
+       /* register 4e.b gets or'ed with one */
+       unsigned char old, new, byte;
+       unsigned short word;
+
+       /* if it fails, it fails. There are so many variations of broken mobos
+        * that it is hard to argue that we should quit at this point.
+        */
+
+       /* dump_pci_device(dev); */
+
+       /* Set the 4MB enable bit bit */
+       byte = pci_read_byte(dev, 0x88);
+       byte |= 0xff;           /* 256K */
+       pci_write_byte(dev, 0x88, byte);
+       byte = pci_read_byte(dev, 0x8c);
+       byte |= 0xff;           /* 1M */
+       pci_write_byte(dev, 0x8c, byte);
+       word = pci_read_word(dev, 0x90);
+       word |= 0x7fff;         /* 15M */
+       pci_write_word(dev, 0x90, word);
+
+       old = pci_read_byte(dev, 0x6d);
+       new = old | 0x01;
+       if (new == old)
+               return 0;
+       pci_write_byte(dev, 0x6d, new);
+
+       if (pci_read_byte(dev, 0x6d) != new) {
+               printf
+                   ("tried to set 0x%x to 0x%x on %s failed (WARNING ONLY)\n",
+                    0x6d, new, name);
+               return -1;
+       }
 
        return 0;
+}
+
+static int enable_flash_ht1000(struct pci_dev *dev, char *name)
+{
+       uint8_t byte;
+
+       /* Set the 4MB enable bit. */
+       byte = pci_read_byte(dev, 0x41);
+       byte |= 0x0e;
+       pci_write_byte(dev, 0x41, byte);
 
+       byte = pci_read_byte(dev, 0x43);
+       byte |= (1 << 4);
+       pci_write_byte(dev, 0x43, byte);
+
+       return 0;
 }
 
 typedef struct penable {
@@ -410,61 +454,60 @@ static FLASH_ENABLE enables[] = {
        {0x1106, 0x8231, "VT8231", enable_flash_vt823x},
        {0x1106, 0x3177, "VT8235", enable_flash_vt823x},
        {0x1106, 0x3227, "VT8237", enable_flash_vt823x},
-       {0x1106, 0x8324, "CX700" , enable_flash_vt823x},
+       {0x1106, 0x8324, "CX700", enable_flash_vt823x},
        {0x1106, 0x0686, "VT82C686", enable_flash_amd8111},
-       {0x1078, 0x0100, "CS5530", enable_flash_cs5530},
+       {0x1078, 0x0100, "CS5530/CS5530A", enable_flash_cs5530},
        {0x100b, 0x0510, "SC1100", enable_flash_sc1100},
        {0x1039, 0x0008, "SIS5595", enable_flash_sis5595},
        {0x1022, 0x7468, "AMD8111", enable_flash_amd8111},
+       {0x10B9, 0x1533, "ALi M1533", enable_flash_ali_m1533},
        /* this fallthrough looks broken. */
-        {0x10de, 0x0050, "NVIDIA CK804", enable_flash_ck804}, /* LPC */
-        {0x10de, 0x0051, "NVIDIA CK804", enable_flash_ck804}, /* Pro */
-        {0x10de, 0x00d3, "NVIDIA CK804", enable_flash_ck804}, /* Slave, should not be here, to fix known bug for A01. */
-
-        {0x10de, 0x0260, "NVidia MCP51", enable_flash_ck804},
-        {0x10de, 0x0261, "NVidia MCP51", enable_flash_ck804},
-        {0x10de, 0x0262, "NVidia MCP51", enable_flash_ck804},
-        {0x10de, 0x0263, "NVidia MCP51", enable_flash_ck804},
-
-       {0x10de, 0x0360, "NVIDIA MCP55", enable_flash_mcp55}, /* Gigabyte m57sli-s4 */
-       {0x10de, 0x0361, "NVIDIA MCP55", enable_flash_mcp55}, /* LPC */
-       {0x10de, 0x0362, "NVIDIA MCP55", enable_flash_mcp55}, /* LPC */
-       {0x10de, 0x0363, "NVIDIA MCP55", enable_flash_mcp55}, /* LPC */
-        {0x10de, 0x0364, "NVIDIA MCP55", enable_flash_mcp55}, /* LPC */
-       {0x10de, 0x0365, "NVIDIA MCP55", enable_flash_mcp55}, /* LPC */
-       {0x10de, 0x0366, "NVIDIA MCP55", enable_flash_mcp55}, /* LPC */
-       {0x10de, 0x0367, "NVIDIA MCP55", enable_flash_mcp55}, /* Pro */
-
-       {0x1002, 0x4377, "ATI SB400", enable_flash_sb400}, /* ATI Technologies Inc IXP SB400 PCI-ISA Bridge (rev 80) */
+       {0x10de, 0x0050, "NVIDIA CK804", enable_flash_ck804},   /* LPC */
+       {0x10de, 0x0051, "NVIDIA CK804", enable_flash_ck804},   /* Pro */
+       {0x10de, 0x00d3, "NVIDIA CK804", enable_flash_ck804},   /* Slave, should not be here, to fix known bug for A01. */
+
+       {0x10de, 0x0260, "NVidia MCP51", enable_flash_ck804},
+       {0x10de, 0x0261, "NVidia MCP51", enable_flash_ck804},
+       {0x10de, 0x0262, "NVidia MCP51", enable_flash_ck804},
+       {0x10de, 0x0263, "NVidia MCP51", enable_flash_ck804},
+
+       {0x10de, 0x0360, "NVIDIA MCP55", enable_flash_mcp55},   /* Gigabyte m57sli-s4 */
+       {0x10de, 0x0361, "NVIDIA MCP55", enable_flash_mcp55},   /* LPC */
+       {0x10de, 0x0362, "NVIDIA MCP55", enable_flash_mcp55},   /* LPC */
+       {0x10de, 0x0363, "NVIDIA MCP55", enable_flash_mcp55},   /* LPC */
+       {0x10de, 0x0364, "NVIDIA MCP55", enable_flash_mcp55},   /* LPC */
+       {0x10de, 0x0365, "NVIDIA MCP55", enable_flash_mcp55},   /* LPC */
+       {0x10de, 0x0366, "NVIDIA MCP55", enable_flash_mcp55},   /* LPC */
+       {0x10de, 0x0367, "NVIDIA MCP55", enable_flash_mcp55},   /* Pro */
+
+       {0x1002, 0x4377, "ATI SB400", enable_flash_sb400},      /* ATI Technologies Inc IXP SB400 PCI-ISA Bridge (rev 80) */
+
+       {0x1166, 0x0205, "Broadcom HT-1000", enable_flash_ht1000},
 };
 
-/*
- *
- */
-int
-chipset_flash_enable(void)
+int chipset_flash_enable(void)
 {
-        struct pci_dev *dev = 0;
-        int ret = -2; /* nothing! */
-        int i;
+       struct pci_dev *dev = 0;
+       int ret = -2;           /* nothing! */
+       int i;
 
        /* now let's try to find the chipset we have ... */
        for (i = 0; i < sizeof(enables) / sizeof(enables[0]); i++) {
-                dev = pci_dev_find(enables[i].vendor, enables[i].device);
-                if (dev)
-                        break;
-        }
-
-        if (dev) {
-                printf("Found chipset \"%s\": Enabling flash write... ",
-                       enables[i].name);
-
-                ret = enables[i].doit(dev, enables[i].name);
-                if (ret)
-                        printf("Failed!\n");
-                else
-                        printf("OK.\n");
+               dev = pci_dev_find(enables[i].vendor, enables[i].device);
+               if (dev)
+                       break;
+       }
+
+       if (dev) {
+               printf("Found chipset \"%s\": Enabling flash write... ",
+                      enables[i].name);
+
+               ret = enables[i].doit(dev, enables[i].name);
+               if (ret)
+                       printf("Failed!\n");
+               else
+                       printf("OK.\n");
        }
 
-        return ret;
+       return ret;
 }