From 384e1c514135b4188dfbe44d81940f38e0fa6167 Mon Sep 17 00:00:00 2001 From: Francis Rowe Date: Tue, 23 Dec 2014 13:07:34 +0000 Subject: ich9deblob: move x86 compatibility checks to a separate file --- resources/utilities/ich9deblob/Makefile | 4 +- resources/utilities/ich9deblob/ich9deblob.c | 158 +-------------- resources/utilities/ich9deblob/ich9desc.c | 217 -------------------- resources/utilities/ich9deblob/ich9desc.h | 228 ++++++++++++++++++++++ resources/utilities/ich9deblob/ich9gbe.c | 43 ---- resources/utilities/ich9deblob/ich9gbe.h | 54 +++++ resources/utilities/ich9deblob/x86compatibility.c | 141 +++++++++++++ 7 files changed, 429 insertions(+), 416 deletions(-) delete mode 100644 resources/utilities/ich9deblob/ich9desc.c create mode 100644 resources/utilities/ich9deblob/ich9desc.h delete mode 100644 resources/utilities/ich9deblob/ich9gbe.c create mode 100644 resources/utilities/ich9deblob/ich9gbe.h create mode 100644 resources/utilities/ich9deblob/x86compatibility.c (limited to 'resources/utilities/ich9deblob') diff --git a/resources/utilities/ich9deblob/Makefile b/resources/utilities/ich9deblob/Makefile index 5ef9587f..656e2a19 100644 --- a/resources/utilities/ich9deblob/Makefile +++ b/resources/utilities/ich9deblob/Makefile @@ -20,8 +20,8 @@ CC=gcc CFLAGS=-I. -ich9deblob: ich9deblob.c ich9desc.c ich9gbe.c - $(CC) $(CFLAGS) ich9deblob.c ich9desc.c ich9gbe.c -o ich9deblob +ich9deblob: ich9deblob.c ich9desc.h ich9gbe.h + $(CC) $(CFLAGS) ich9deblob.c ich9desc.h ich9gbe.h -o ich9deblob clean: rm -f ich9deblob *.o diff --git a/resources/utilities/ich9deblob/ich9deblob.c b/resources/utilities/ich9deblob/ich9deblob.c index 36307669..66b9c9ba 100644 --- a/resources/utilities/ich9deblob/ich9deblob.c +++ b/resources/utilities/ich9deblob/ich9deblob.c @@ -1,5 +1,5 @@ /* - * main.c + * ich9deblob.c * This file is part of the ich9deblob utility from the libreboot project * * Purpose: disable and remove the ME from ich9m/gm45 machines in coreboot. @@ -42,30 +42,15 @@ #include #include -#include "ich9desc.c" // structs describing what's in the descriptor region -#include "ich9gbe.c" // structs describing what's in the gbe region - -#define DESCRIPTORREGIONSIZE 0x1000 // 4 KiB -#define GBEREGIONSIZE 0x2000 // 8 KiB -// These will have a modified descriptor+gbe based on what's in the factory.rom -// These will be joined into a single 12KiB buffer (descriptor, then gbe) and saved to a file -// NOTE: The GBE region of 8K is actually 2x 4K regions in a single region; both 4K blocks can be identical (and by default, are) -// The 2nd one is a "backup", but we don't know when it's used. perhaps it's used when the checksum on the first one does not match? - -// Related to the flash descriptor -#define FLREGIONBITSHIFT 0xC // bits 12(0xC)-24(0x18) are represented for words found in the flash descriptor - // To manipulate these easily in C, we shift them by FLREGIONBITSHIFT and then shift them back when done +#include "ich9desc.h" // structs describing what's in the descriptor region +#include "ich9gbe.h" // structs describing what's in the gbe region +#include "x86compatibility.c" // compatibility checks. this utility is not portable yet. unsigned short gbeGetChecksumFrom4kStruct(struct GBEREGIONRECORD_4K gbeStruct4k, unsigned short desiredValue); unsigned short gbeGetChecksumFrom8kBuffer(char* buffer, unsigned short desiredValue, char isBackup); // for GBe region (checksum calculation) unsigned short gbeGetRegionWordFrom8kBuffer(int i, char* buffer); // used for getting each word needed to calculate said checksum struct DESCRIPTORREGIONRECORD deblobbedDescriptorStructFromFactory(struct DESCRIPTORREGIONRECORD factoryDescriptorStruct, unsigned int factoryRomSize); -int structSizesIncorrect(struct DESCRIPTORREGIONRECORD descriptorDummy, struct GBEREGIONRECORD_8K gbe8kDummy); -int systemIsBigEndian(); -int structBitfieldWrongOrder(); -int structMembersWrongOrder(); struct GBEREGIONRECORD_8K deblobbedGbeStructFromFactory(struct GBEREGIONRECORD_8K factoryGbeStruct8k); -int systemOrCompilerIncompatible(struct DESCRIPTORREGIONRECORD descriptorStruct, struct GBEREGIONRECORD_8K gbeStruct8k); int main(int argc, char *argv[]) { @@ -371,138 +356,3 @@ unsigned short gbeGetRegionWordFrom8kBuffer(int index, char* regionData) return *((unsigned short*)(regionData + (index * 2))); } -// --------------------------------------------------------------------- -// x86 compatibility checking: -// --------------------------------------------------------------------- - -// Basically, this should only return true on non-x86 machines -int structSizesIncorrect(struct DESCRIPTORREGIONRECORD descriptorDummy, struct GBEREGIONRECORD_8K gbe8kDummy) { - unsigned int descriptorRegionStructSize = sizeof(descriptorDummy); - unsigned int gbeRegion8kStructSize = sizeof(gbe8kDummy); - // check compiler bit-packs in a compatible way. basically, it is expected that this code will be used on x86 - if (DESCRIPTORREGIONSIZE != descriptorRegionStructSize){ - printf("\nerror: compiler incompatibility: descriptor struct length is %i bytes (should be %i)\n", descriptorRegionStructSize, DESCRIPTORREGIONSIZE); - return 1; - } - if (GBEREGIONSIZE != gbeRegion8kStructSize){ - printf("\nerror: compiler incompatibility: gbe struct length is %i bytes (should be %i)\n", gbeRegion8kStructSize, GBEREGIONSIZE); - return 1; - } - return 0; -} - -int systemIsBigEndian() { - // endianness check. big endian forced to fail - unsigned short steak = 0xBEEF; - unsigned char *grill = (unsigned char*)&steak; - if (*grill==0xBE) { - printf("\nunsigned short 0xBEEF: first byte should be EF, but it's BE. Your system is big endian, and unsupported (only little endian is tested)\n"); - return 1; - } - return 0; -} - -// fail if members are presented in the wrong order -int structMembersWrongOrder() -{ - int i; - struct DESCRIPTORREGIONRECORD descriptorDummy; - unsigned char *meVsccTablePtr = (unsigned char*)&descriptorDummy.meVsccTable; - - // These do not use bitfields. - descriptorDummy.meVsccTable.jid0 = 0x01020304; // unsigned int 32-bit - descriptorDummy.meVsccTable.vscc0 = 0x10203040; // unsigned int 32-bit - descriptorDummy.meVsccTable.jid1 = 0x11223344; // unsigned int 32-bit - descriptorDummy.meVsccTable.vscc1 = 0x05060708; // unsigned int 32-bit - descriptorDummy.meVsccTable.jid2 = 0x50607080; // unsigned int 32-bit - descriptorDummy.meVsccTable.vscc2 = 0x55667788; // unsigned int 32-bit - descriptorDummy.meVsccTable.padding[0] = 0xAA; // unsigned char 8-bit - descriptorDummy.meVsccTable.padding[1] = 0xBB; // unsigned char 8-bit - descriptorDummy.meVsccTable.padding[2] = 0xCC; // unsigned char 8-bit - descriptorDummy.meVsccTable.padding[3] = 0xDD; // unsigned char 8-bit - - // Look from the top down, and concatenate the unsigned ints but - // with each unsigned in little endian order. - // Then, concatenate the unsigned chars in big endian order. (in the padding array) - - // combined, these should become: - // 01020304 10203040 11223344 05060708 50607080 55667788 AA BB CC DD (ignore this. big endian. just working it out manually:) - // 04030201 40302010 44332211 08070605 80706050 88776655 AA BB CC DD (ignore this. not byte-separated, just working it out:) - // 04 03 02 01 40 30 20 10 44 33 22 11 08 07 06 05 80 70 60 50 88 77 66 55 AA BB CC DD <-- it should match this - - printf("\nStruct member order check (descriptorDummy.meVsccTable) with junk/dummy data:"); - printf("\nShould be: 04 03 02 01 40 30 20 10 44 33 22 11 08 07 06 05 80 70 60 50 88 77 66 55 aa bb cc dd "); - printf("\nAnd it is: "); - - for (i = 0; i < 28; i++) { - printf("%02x ", *(meVsccTablePtr + i)); - } - printf("\n"); - - if ( - ! - ( - *meVsccTablePtr == 0x04 && *(meVsccTablePtr+1) == 0x03 && *(meVsccTablePtr+2) == 0x02 && *(meVsccTablePtr+3) == 0x01 - && *(meVsccTablePtr+4) == 0x40 && *(meVsccTablePtr+5) == 0x30 && *(meVsccTablePtr+6) == 0x20 && *(meVsccTablePtr+7) == 0x10 - && *(meVsccTablePtr+8) == 0x44 && *(meVsccTablePtr+9) == 0x33 && *(meVsccTablePtr+10) == 0x22 && *(meVsccTablePtr+11) == 0x11 - && *(meVsccTablePtr+12) == 0x08 && *(meVsccTablePtr+13) == 0x07 && *(meVsccTablePtr+14) == 0x06 && *(meVsccTablePtr+15) == 0x05 - && *(meVsccTablePtr+16) == 0x80 && *(meVsccTablePtr+17) == 0x70 && *(meVsccTablePtr+18) == 0x60 && *(meVsccTablePtr+19) == 0x50 - && *(meVsccTablePtr+20) == 0x88 && *(meVsccTablePtr+21) == 0x77 && *(meVsccTablePtr+22) == 0x66 && *(meVsccTablePtr+23) == 0x55 - && *(meVsccTablePtr+24) == 0xAA && *(meVsccTablePtr+25) == 0xBB && *(meVsccTablePtr+26) == 0xCC && *(meVsccTablePtr+27) == 0xDD - ) - ) { - printf("Incorrect order.\n"); - return 1; - } - printf("Correct order.\n"); - return 0; -} - -// fail if bit fields are presented in the wrong order -int structBitfieldWrongOrder() -{ - int i; - struct DESCRIPTORREGIONRECORD descriptorDummy; - unsigned char *flMap0Ptr = (unsigned char*)&descriptorDummy.flMaps.flMap0; - - descriptorDummy.flMaps.flMap0.FCBA = 0xA2; // :8 --> 10100010 - descriptorDummy.flMaps.flMap0.NC = 0x02; // :2 --> 10 - descriptorDummy.flMaps.flMap0.reserved1 = 0x38; // :6 --> 111000 - descriptorDummy.flMaps.flMap0.FRBA = 0xD2; // :8 --> 11010010 - descriptorDummy.flMaps.flMap0.NR = 0x05; // :3 --> 101 - descriptorDummy.flMaps.flMap0.reserved2 = 0x1C; // :5 --> 11100 - - // Look from the top bottom up, and concatenate the binary strings. - // Then, convert the 8-bit groups to hex and reverse the (8-bit)byte order - - // combined, these should become (in memory), in binary: - // 10100010 11100010 11010010 11100101 - // or in hex: - // A2 E2 D2 E5 - - printf("\nBitfield order check (descriptorDummy.flMaps.flMaps0) with junk/dummy data:"); - printf("\nShould be: a2 e2 d2 e5 "); - printf("\nAnd it is: "); - - for (i = 0; i < 4; i++) { - printf("%02x ", *(flMap0Ptr + i)); - } - printf("\n"); - - if (!(*flMap0Ptr == 0xA2 && *(flMap0Ptr+1) == 0xE2 && *(flMap0Ptr+2) == 0xD2 && *(flMap0Ptr+3) == 0xE5)) { - printf("Incorrect order.\n"); - return 1; - } - printf("Correct order.\n"); - return 0; -} - -// Compatibility checks. This version of ich9deblob is not yet porable. -int systemOrCompilerIncompatible(struct DESCRIPTORREGIONRECORD descriptorStruct, struct GBEREGIONRECORD_8K gbeStruct8k) -{ - if (structSizesIncorrect(descriptorStruct, gbeStruct8k)) return 1; - if (systemIsBigEndian()) return 1; - if (structBitfieldWrongOrder()) return 1; - if (structMembersWrongOrder()) return 1; - return 0; -} diff --git a/resources/utilities/ich9deblob/ich9desc.c b/resources/utilities/ich9deblob/ich9desc.c deleted file mode 100644 index 893b0fd3..00000000 --- a/resources/utilities/ich9deblob/ich9desc.c +++ /dev/null @@ -1,217 +0,0 @@ -/* - * ich9desc.c - * This file is part of the ich9deblob utility from the libreboot project - * - * Copyright (C) 2014 Steve Shenton - * Francis Rowe - * - * 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, either version 3 of the License, or - * (at your option) any later version. - * - * 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, see . - */ - -// Purpose: provide struct representing descriptor region. -// Map actual buffers of this regions, directly to instances of these -// structs. This makes working with descriptor really easy. - -// bit fields used, corresponding to datasheet. See links to datasheets -// and documentation in ich9deblob.c - -struct FLVALSIG{ - unsigned int signature; -}; - -struct FLMAP0 { - // least signicant bits - unsigned char FCBA : 8; - unsigned char NC : 2; - unsigned char reserved1 : 6; - // ^^^^ unnamed members like these represent unused bits (per datasheet). - // the same applies for all structs in this file. - unsigned char FRBA : 8; - unsigned char NR : 3; - unsigned char reserved2 : 5; - // most significant bits. - - // the datasheet lists msb's first and lsb's last, in each table. - // meanwhile, x86 gcc treats the members at the top of the struct as lsb's - // and at the bottom of the struct, the members there are msb's. The same - // fact applies to all the other structs below. - - // non-x86 (and/or non-gcc) is untested - // little endian assumed -}; - -struct FLMAP1 { - unsigned char FMBA : 8; - unsigned char NM : 3; - unsigned char reserved : 5; - unsigned char FISBA : 8; - unsigned char ISL : 8; -}; - -struct FLMAP2 { - unsigned char FMSBA : 8; - unsigned char MSL : 8; - unsigned short reserved : 16; -}; - -struct FLMAPS { - struct FLMAP0 flMap0; - struct FLMAP1 flMap1; - struct FLMAP2 flMap2; -}; - -struct FLCOMP { - unsigned char component1Density : 3; - unsigned char component2Density : 3; - unsigned char reserved1 : 2; - unsigned char reserved2 : 8; - unsigned char reserved3 : 1; - unsigned char readClockFrequency : 3; - unsigned char fastReadSupport : 1; - unsigned char fastreadClockFrequency : 3; - unsigned char writeEraseClockFrequency : 3; - unsigned char readStatusClockFrequency : 3; - unsigned char reserved4 : 2; -}; - -struct COMPONENTSECTIONRECORD { - struct FLCOMP flcomp; - unsigned int flill; - unsigned int flpb; - unsigned char padding[36]; -}; - -struct FLREG { - unsigned short BASE : 13; - unsigned short reserved1 : 3; - unsigned short LIMIT : 13; - unsigned short reserved2 : 3; -}; - -struct REGIONSECTIONRECORD { - struct FLREG flReg0; // Descriptor - struct FLREG flReg1; // BIOS - struct FLREG flReg2; // ME - struct FLREG flReg3; // Gbe - struct FLREG flReg4; // Platform - unsigned char padding[12]; -}; - -struct FLMSTR { - unsigned short requesterId : 16; - unsigned char fdRegionReadAccess : 1; - unsigned char biosRegionReadAccess : 1; - unsigned char meRegionReadAccess : 1; - unsigned char gbeRegionReadAccess : 1; - unsigned char pdRegionReadAccess : 1; - unsigned char reserved1 : 3; - unsigned char fdRegionWriteAccess : 1; - unsigned char biosRegionWriteAccess : 1; - unsigned char meRegionWriteAccess : 1; - unsigned char gbeRegionWriteAccess : 1; - unsigned char pdRegionWriteAccess : 1; - unsigned char reserved2 : 3; -}; - - -struct MASTERACCESSSECTIONRECORD { - struct FLMSTR flMstr1; - struct FLMSTR flMstr2; - struct FLMSTR flMstr3; - unsigned char padding[148]; -}; - -struct ICHSTRAP0 { - // todo: add MeSmBus2Sel (boring setting) - unsigned char meDisable : 1; // If true, ME is disabled. - unsigned char reserved1 : 6; - unsigned char tcoMode : 1; // TCO Mode: (Legacy,TCO Mode) The TCO Mode, along with the BMCMODE strap, determines the behavior of the IAMT SmBus controller. - unsigned char smBusAddress : 7; // The ME SmBus 7-bit address. - unsigned char bmcMode : 1; // BMC mode: If true, device is in BMC mode. If Intel(R) AMT or ASF using Intel integrated LAN then this should be false. - unsigned char tripPointSelect : 1; // Trip Point Select: false the NJCLK input buffer is matched to 3.3v signal from the external PHY device, true is matched to 1.8v. - unsigned char reserved2 : 2; - unsigned char integratedGbe : 1; // Integrated GbE or PCI Express select: (PCI Express,,Integrated GbE) Defines what PCIe Port 6 is used for. - unsigned char lanPhy : 1; // LANPHYPC_GP12_SEL: Set to 0 for GP12 to be used as GPIO (General Purpose Input/Output), or 1 for GP12 to be used for native mode as LAN_PHYPC for 82566 LCD device - unsigned char reserved3 : 3; - unsigned char dmiRequesterId : 1; // DMI requestor ID security check disable: The primary purpose of this strap is to support server environments with multiple CPUs that each have a different RequesterID that can access the Flash. - unsigned char smBus2Address : 7; // The ME SmBus 2 7-bit address. -}; - -struct ICHSTRAP1 { - unsigned char northMlink : 1; // North MLink Dynamic Clock Gate Disable : Sets the default value for the South MLink Dynamic Clock Gate Enable registers. - unsigned char southMlink : 1; // South MLink Dynamic Clock Gate Enable : Sets the default value for the South MLink Dynamic Clock Gate Enable registers. - unsigned char meSmbus : 1; // ME SmBus Dynamic Clock Gate Enable : Sets the default value for the ME SMBus Dynamic Clock Gate Enable for both the ME SmBus controllers. - unsigned char sstDynamic : 1; // SST Dynamic Clock Gate Enable : Sets the default value for the SST Clock Gate Enable registers. - unsigned char reserved1 : 4; - unsigned char northMlink2 : 1; // North MLink 2 Non-Posted Enable : 'true':North MLink supports two downstream non-posted requests. 'false':North MLink supports one downstream non-posted requests. - unsigned char reserved2 : 7; - unsigned short reserved3 : 16; -}; - - -struct ICHSTRAPSRECORD { - struct ICHSTRAP0 ichStrap0; - struct ICHSTRAP1 ichStrap1; - unsigned char padding[248]; -}; - -struct MCHSTRAP0 { - unsigned char meDisable : 1; // If true, ME is disabled. - unsigned char meBootFromFlash : 1; // ME boot from Flash - guessed location - unsigned char tpmDisable : 1; // iTPM Disable : When set true, iTPM Host Interface is disabled. When set false (default), iTPM is enabled. - unsigned char reserved1 : 3; - unsigned char spiFingerprint : 1; // SPI Fingerprint Sensor Present: Indicates if an SPI Fingerprint sensor is present at CS#1. - unsigned char meAlternateDisable : 1; // ME Alternate Disable: Setting this bit allows ME to perform critical chipset functions but prevents loading of any ME FW applications. - unsigned char reserved2 : 8; - unsigned short reserved3 : 16; -}; - -struct MCHSTRAPSRECORD { - struct MCHSTRAP0 mchStrap0; - unsigned char padding[3292]; -}; - -struct MEVSCCTABLERECORD { - unsigned int jid0; - unsigned int vscc0; - unsigned int jid1; - unsigned int vscc1; - unsigned int jid2; - unsigned int vscc2; - unsigned char padding[4]; -}; - -struct DESCRIPTORMAP2RECORD { - unsigned char meVsccTableBaseAddress : 8; - unsigned char meVsccTableLength : 8; - unsigned short reserved : 16; -}; - -struct OEMSECTIONRECORD { - unsigned char magicString[8]; - unsigned char padding[248]; -}; - -struct DESCRIPTORREGIONRECORD { - struct FLVALSIG flValSig; - struct FLMAPS flMaps; - struct COMPONENTSECTIONRECORD componentSection; - struct REGIONSECTIONRECORD regionSection; - struct MASTERACCESSSECTIONRECORD masterAccessSection; - struct ICHSTRAPSRECORD ichStraps; - struct MCHSTRAPSRECORD mchStraps; - struct MEVSCCTABLERECORD meVsccTable; - struct DESCRIPTORMAP2RECORD descriptor2Map; - struct OEMSECTIONRECORD oemSection; -}; diff --git a/resources/utilities/ich9deblob/ich9desc.h b/resources/utilities/ich9deblob/ich9desc.h new file mode 100644 index 00000000..7463e5c2 --- /dev/null +++ b/resources/utilities/ich9deblob/ich9desc.h @@ -0,0 +1,228 @@ +/* + * ich9desc.h + * This file is part of the ich9deblob utility from the libreboot project + * + * Copyright (C) 2014 Steve Shenton + * Francis Rowe + * + * 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, either version 3 of the License, or + * (at your option) any later version. + * + * 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, see . + */ + +// Purpose: provide struct representing descriptor region. +// Map actual buffers of this regions, directly to instances of these +// structs. This makes working with descriptor really easy. + +// bit fields used, corresponding to datasheet. See links to datasheets +// and documentation in ich9deblob.c + +#ifndef ICH9DESC_H +#define ICH9DESC_H + +#define DESCRIPTORREGIONSIZE 0x1000 // 4 KiB + +// Related to the flash descriptor +#define FLREGIONBITSHIFT 0xC // bits 12(0xC)-24(0x18) are represented for words found in the flash descriptor + // To manipulate these easily in C, we shift them by FLREGIONBITSHIFT and then shift them back when done + +struct FLVALSIG{ + unsigned int signature; +}; + +struct FLMAP0 { + // least signicant bits + unsigned char FCBA : 8; + unsigned char NC : 2; + unsigned char reserved1 : 6; + // ^^^^ unnamed members like these represent unused bits (per datasheet). + // the same applies for all structs in this file. + unsigned char FRBA : 8; + unsigned char NR : 3; + unsigned char reserved2 : 5; + // most significant bits. + + // the datasheet lists msb's first and lsb's last, in each table. + // meanwhile, x86 gcc treats the members at the top of the struct as lsb's + // and at the bottom of the struct, the members there are msb's. The same + // fact applies to all the other structs below. + + // non-x86 (and/or non-gcc) is untested + // little endian assumed +}; + +struct FLMAP1 { + unsigned char FMBA : 8; + unsigned char NM : 3; + unsigned char reserved : 5; + unsigned char FISBA : 8; + unsigned char ISL : 8; +}; + +struct FLMAP2 { + unsigned char FMSBA : 8; + unsigned char MSL : 8; + unsigned short reserved : 16; +}; + +struct FLMAPS { + struct FLMAP0 flMap0; + struct FLMAP1 flMap1; + struct FLMAP2 flMap2; +}; + +struct FLCOMP { + unsigned char component1Density : 3; + unsigned char component2Density : 3; + unsigned char reserved1 : 2; + unsigned char reserved2 : 8; + unsigned char reserved3 : 1; + unsigned char readClockFrequency : 3; + unsigned char fastReadSupport : 1; + unsigned char fastreadClockFrequency : 3; + unsigned char writeEraseClockFrequency : 3; + unsigned char readStatusClockFrequency : 3; + unsigned char reserved4 : 2; +}; + +struct COMPONENTSECTIONRECORD { + struct FLCOMP flcomp; + unsigned int flill; + unsigned int flpb; + unsigned char padding[36]; +}; + +struct FLREG { + unsigned short BASE : 13; + unsigned short reserved1 : 3; + unsigned short LIMIT : 13; + unsigned short reserved2 : 3; +}; + +struct REGIONSECTIONRECORD { + struct FLREG flReg0; // Descriptor + struct FLREG flReg1; // BIOS + struct FLREG flReg2; // ME + struct FLREG flReg3; // Gbe + struct FLREG flReg4; // Platform + unsigned char padding[12]; +}; + +struct FLMSTR { + unsigned short requesterId : 16; + unsigned char fdRegionReadAccess : 1; + unsigned char biosRegionReadAccess : 1; + unsigned char meRegionReadAccess : 1; + unsigned char gbeRegionReadAccess : 1; + unsigned char pdRegionReadAccess : 1; + unsigned char reserved1 : 3; + unsigned char fdRegionWriteAccess : 1; + unsigned char biosRegionWriteAccess : 1; + unsigned char meRegionWriteAccess : 1; + unsigned char gbeRegionWriteAccess : 1; + unsigned char pdRegionWriteAccess : 1; + unsigned char reserved2 : 3; +}; + + +struct MASTERACCESSSECTIONRECORD { + struct FLMSTR flMstr1; + struct FLMSTR flMstr2; + struct FLMSTR flMstr3; + unsigned char padding[148]; +}; + +struct ICHSTRAP0 { + // todo: add MeSmBus2Sel (boring setting) + unsigned char meDisable : 1; // If true, ME is disabled. + unsigned char reserved1 : 6; + unsigned char tcoMode : 1; // TCO Mode: (Legacy,TCO Mode) The TCO Mode, along with the BMCMODE strap, determines the behavior of the IAMT SmBus controller. + unsigned char smBusAddress : 7; // The ME SmBus 7-bit address. + unsigned char bmcMode : 1; // BMC mode: If true, device is in BMC mode. If Intel(R) AMT or ASF using Intel integrated LAN then this should be false. + unsigned char tripPointSelect : 1; // Trip Point Select: false the NJCLK input buffer is matched to 3.3v signal from the external PHY device, true is matched to 1.8v. + unsigned char reserved2 : 2; + unsigned char integratedGbe : 1; // Integrated GbE or PCI Express select: (PCI Express,,Integrated GbE) Defines what PCIe Port 6 is used for. + unsigned char lanPhy : 1; // LANPHYPC_GP12_SEL: Set to 0 for GP12 to be used as GPIO (General Purpose Input/Output), or 1 for GP12 to be used for native mode as LAN_PHYPC for 82566 LCD device + unsigned char reserved3 : 3; + unsigned char dmiRequesterId : 1; // DMI requestor ID security check disable: The primary purpose of this strap is to support server environments with multiple CPUs that each have a different RequesterID that can access the Flash. + unsigned char smBus2Address : 7; // The ME SmBus 2 7-bit address. +}; + +struct ICHSTRAP1 { + unsigned char northMlink : 1; // North MLink Dynamic Clock Gate Disable : Sets the default value for the South MLink Dynamic Clock Gate Enable registers. + unsigned char southMlink : 1; // South MLink Dynamic Clock Gate Enable : Sets the default value for the South MLink Dynamic Clock Gate Enable registers. + unsigned char meSmbus : 1; // ME SmBus Dynamic Clock Gate Enable : Sets the default value for the ME SMBus Dynamic Clock Gate Enable for both the ME SmBus controllers. + unsigned char sstDynamic : 1; // SST Dynamic Clock Gate Enable : Sets the default value for the SST Clock Gate Enable registers. + unsigned char reserved1 : 4; + unsigned char northMlink2 : 1; // North MLink 2 Non-Posted Enable : 'true':North MLink supports two downstream non-posted requests. 'false':North MLink supports one downstream non-posted requests. + unsigned char reserved2 : 7; + unsigned short reserved3 : 16; +}; + + +struct ICHSTRAPSRECORD { + struct ICHSTRAP0 ichStrap0; + struct ICHSTRAP1 ichStrap1; + unsigned char padding[248]; +}; + +struct MCHSTRAP0 { + unsigned char meDisable : 1; // If true, ME is disabled. + unsigned char meBootFromFlash : 1; // ME boot from Flash - guessed location + unsigned char tpmDisable : 1; // iTPM Disable : When set true, iTPM Host Interface is disabled. When set false (default), iTPM is enabled. + unsigned char reserved1 : 3; + unsigned char spiFingerprint : 1; // SPI Fingerprint Sensor Present: Indicates if an SPI Fingerprint sensor is present at CS#1. + unsigned char meAlternateDisable : 1; // ME Alternate Disable: Setting this bit allows ME to perform critical chipset functions but prevents loading of any ME FW applications. + unsigned char reserved2 : 8; + unsigned short reserved3 : 16; +}; + +struct MCHSTRAPSRECORD { + struct MCHSTRAP0 mchStrap0; + unsigned char padding[3292]; +}; + +struct MEVSCCTABLERECORD { + unsigned int jid0; + unsigned int vscc0; + unsigned int jid1; + unsigned int vscc1; + unsigned int jid2; + unsigned int vscc2; + unsigned char padding[4]; +}; + +struct DESCRIPTORMAP2RECORD { + unsigned char meVsccTableBaseAddress : 8; + unsigned char meVsccTableLength : 8; + unsigned short reserved : 16; +}; + +struct OEMSECTIONRECORD { + unsigned char magicString[8]; + unsigned char padding[248]; +}; + +struct DESCRIPTORREGIONRECORD { + struct FLVALSIG flValSig; + struct FLMAPS flMaps; + struct COMPONENTSECTIONRECORD componentSection; + struct REGIONSECTIONRECORD regionSection; + struct MASTERACCESSSECTIONRECORD masterAccessSection; + struct ICHSTRAPSRECORD ichStraps; + struct MCHSTRAPSRECORD mchStraps; + struct MEVSCCTABLERECORD meVsccTable; + struct DESCRIPTORMAP2RECORD descriptor2Map; + struct OEMSECTIONRECORD oemSection; +}; + +#endif diff --git a/resources/utilities/ich9deblob/ich9gbe.c b/resources/utilities/ich9deblob/ich9gbe.c deleted file mode 100644 index 1740dbd4..00000000 --- a/resources/utilities/ich9deblob/ich9gbe.c +++ /dev/null @@ -1,43 +0,0 @@ -/* - * ich9gbe.c - * This file is part of the ich9deblob utility from the libreboot project - * - * Copyright (C) 2014 Francis Rowe - * - * 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, either version 3 of the License, or - * (at your option) any later version. - * - * 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, see . - */ - -// Purpose: provide struct representing gbe region. -// Map actual buffers of this regions, directly to instances of these -// structs. This makes working with gbe really easy. - -// bit fields used, corresponding to datasheet. See links to datasheets -// and documentation in ich9deblob.c - -struct GBEREGIONRECORD_4K { - unsigned char macAddress[6]; // 0x03 words, or 0x06 bytes - unsigned char otherStuff[120]; // 0x3c words, or 0x7E bytes - unsigned short checkSum; // when added to the sum of all words above, this should be 0xBABA - unsigned char padding1[3968]; -}; - -// main and backup region in gbe -struct GBEREGIONRECORD_8K { - struct GBEREGIONRECORD_4K main; - struct GBEREGIONRECORD_4K backup; - // Backup region: - // This is actually "main" on X200, since the real main has a bad checksum - // and other errors. You should do what you need on this one (if modifying - // lenovobios's gbe region) and then copy to main -}; diff --git a/resources/utilities/ich9deblob/ich9gbe.h b/resources/utilities/ich9deblob/ich9gbe.h new file mode 100644 index 00000000..26b125bc --- /dev/null +++ b/resources/utilities/ich9deblob/ich9gbe.h @@ -0,0 +1,54 @@ +/* + * ich9gbe.h + * This file is part of the ich9deblob utility from the libreboot project + * + * Copyright (C) 2014 Francis Rowe + * + * 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, either version 3 of the License, or + * (at your option) any later version. + * + * 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, see . + */ + +// Purpose: provide struct representing gbe region. +// Map actual buffers of this regions, directly to instances of these +// structs. This makes working with gbe really easy. + +// bit fields used, corresponding to datasheet. See links to datasheets +// and documentation in ich9deblob.c + +#ifndef ICH9GBE_H +#define ICH9GBE_H + +#define GBEREGIONSIZE 0x2000 // 8 KiB +// These will have a modified descriptor+gbe based on what's in the factory.rom +// These will be joined into a single 12KiB buffer (descriptor, then gbe) and saved to a file +// NOTE: The GBE region of 8K is actually 2x 4K regions in a single region; both 4K blocks can be identical (and by default, are) +// The 2nd one is a "backup", but we don't know when it's used. perhaps it's used when the checksum on the first one does not match? + +struct GBEREGIONRECORD_4K { + unsigned char macAddress[6]; // 0x03 words, or 0x06 bytes + unsigned char otherStuff[120]; // 0x3c words, or 0x7E bytes + unsigned short checkSum; // when added to the sum of all words above, this should be 0xBABA + unsigned char padding1[3968]; +}; + +// main and backup region in gbe +struct GBEREGIONRECORD_8K { + struct GBEREGIONRECORD_4K main; + struct GBEREGIONRECORD_4K backup; + // Backup region: + // This is actually "main" on X200, since the real main has a bad checksum + // and other errors. You should do what you need on this one (if modifying + // lenovobios's gbe region) and then copy to main +}; + +#endif diff --git a/resources/utilities/ich9deblob/x86compatibility.c b/resources/utilities/ich9deblob/x86compatibility.c new file mode 100644 index 00000000..80aa0626 --- /dev/null +++ b/resources/utilities/ich9deblob/x86compatibility.c @@ -0,0 +1,141 @@ +#include +#include + +#include "ich9desc.h" // structs describing what's in the descriptor region +#include "ich9gbe.h" // structs describing what's in the gbe region + +// --------------------------------------------------------------------- +// x86 compatibility checking: +// --------------------------------------------------------------------- + +// Basically, this should only return true on non-x86 machines +int structSizesIncorrect(struct DESCRIPTORREGIONRECORD descriptorDummy, struct GBEREGIONRECORD_8K gbe8kDummy) { + unsigned int descriptorRegionStructSize = sizeof(descriptorDummy); + unsigned int gbeRegion8kStructSize = sizeof(gbe8kDummy); + // check compiler bit-packs in a compatible way. basically, it is expected that this code will be used on x86 + if (DESCRIPTORREGIONSIZE != descriptorRegionStructSize){ + printf("\nerror: compiler incompatibility: descriptor struct length is %i bytes (should be %i)\n", descriptorRegionStructSize, DESCRIPTORREGIONSIZE); + return 1; + } + if (GBEREGIONSIZE != gbeRegion8kStructSize){ + printf("\nerror: compiler incompatibility: gbe struct length is %i bytes (should be %i)\n", gbeRegion8kStructSize, GBEREGIONSIZE); + return 1; + } + return 0; +} + +int systemIsBigEndian() { + // endianness check. big endian forced to fail + unsigned short steak = 0xBEEF; + unsigned char *grill = (unsigned char*)&steak; + if (*grill==0xBE) { + printf("\nunsigned short 0xBEEF: first byte should be EF, but it's BE. Your system is big endian, and unsupported (only little endian is tested)\n"); + return 1; + } + return 0; +} + +// fail if members are presented in the wrong order +int structMembersWrongOrder() +{ + int i; + struct DESCRIPTORREGIONRECORD descriptorDummy; + unsigned char *meVsccTablePtr = (unsigned char*)&descriptorDummy.meVsccTable; + + // These do not use bitfields. + descriptorDummy.meVsccTable.jid0 = 0x01020304; // unsigned int 32-bit + descriptorDummy.meVsccTable.vscc0 = 0x10203040; // unsigned int 32-bit + descriptorDummy.meVsccTable.jid1 = 0x11223344; // unsigned int 32-bit + descriptorDummy.meVsccTable.vscc1 = 0x05060708; // unsigned int 32-bit + descriptorDummy.meVsccTable.jid2 = 0x50607080; // unsigned int 32-bit + descriptorDummy.meVsccTable.vscc2 = 0x55667788; // unsigned int 32-bit + descriptorDummy.meVsccTable.padding[0] = 0xAA; // unsigned char 8-bit + descriptorDummy.meVsccTable.padding[1] = 0xBB; // unsigned char 8-bit + descriptorDummy.meVsccTable.padding[2] = 0xCC; // unsigned char 8-bit + descriptorDummy.meVsccTable.padding[3] = 0xDD; // unsigned char 8-bit + + // Look from the top down, and concatenate the unsigned ints but + // with each unsigned in little endian order. + // Then, concatenate the unsigned chars in big endian order. (in the padding array) + + // combined, these should become: + // 01020304 10203040 11223344 05060708 50607080 55667788 AA BB CC DD (ignore this. big endian. just working it out manually:) + // 04030201 40302010 44332211 08070605 80706050 88776655 AA BB CC DD (ignore this. not byte-separated, just working it out:) + // 04 03 02 01 40 30 20 10 44 33 22 11 08 07 06 05 80 70 60 50 88 77 66 55 AA BB CC DD <-- it should match this + + printf("\nStruct member order check (descriptorDummy.meVsccTable) with junk/dummy data:"); + printf("\nShould be: 04 03 02 01 40 30 20 10 44 33 22 11 08 07 06 05 80 70 60 50 88 77 66 55 aa bb cc dd "); + printf("\nAnd it is: "); + + for (i = 0; i < 28; i++) { + printf("%02x ", *(meVsccTablePtr + i)); + } + printf("\n"); + + if ( + ! + ( + *meVsccTablePtr == 0x04 && *(meVsccTablePtr+1) == 0x03 && *(meVsccTablePtr+2) == 0x02 && *(meVsccTablePtr+3) == 0x01 + && *(meVsccTablePtr+4) == 0x40 && *(meVsccTablePtr+5) == 0x30 && *(meVsccTablePtr+6) == 0x20 && *(meVsccTablePtr+7) == 0x10 + && *(meVsccTablePtr+8) == 0x44 && *(meVsccTablePtr+9) == 0x33 && *(meVsccTablePtr+10) == 0x22 && *(meVsccTablePtr+11) == 0x11 + && *(meVsccTablePtr+12) == 0x08 && *(meVsccTablePtr+13) == 0x07 && *(meVsccTablePtr+14) == 0x06 && *(meVsccTablePtr+15) == 0x05 + && *(meVsccTablePtr+16) == 0x80 && *(meVsccTablePtr+17) == 0x70 && *(meVsccTablePtr+18) == 0x60 && *(meVsccTablePtr+19) == 0x50 + && *(meVsccTablePtr+20) == 0x88 && *(meVsccTablePtr+21) == 0x77 && *(meVsccTablePtr+22) == 0x66 && *(meVsccTablePtr+23) == 0x55 + && *(meVsccTablePtr+24) == 0xAA && *(meVsccTablePtr+25) == 0xBB && *(meVsccTablePtr+26) == 0xCC && *(meVsccTablePtr+27) == 0xDD + ) + ) { + printf("Incorrect order.\n"); + return 1; + } + printf("Correct order.\n"); + return 0; +} + +// fail if bit fields are presented in the wrong order +int structBitfieldWrongOrder() +{ + int i; + struct DESCRIPTORREGIONRECORD descriptorDummy; + unsigned char *flMap0Ptr = (unsigned char*)&descriptorDummy.flMaps.flMap0; + + descriptorDummy.flMaps.flMap0.FCBA = 0xA2; // :8 --> 10100010 + descriptorDummy.flMaps.flMap0.NC = 0x02; // :2 --> 10 + descriptorDummy.flMaps.flMap0.reserved1 = 0x38; // :6 --> 111000 + descriptorDummy.flMaps.flMap0.FRBA = 0xD2; // :8 --> 11010010 + descriptorDummy.flMaps.flMap0.NR = 0x05; // :3 --> 101 + descriptorDummy.flMaps.flMap0.reserved2 = 0x1C; // :5 --> 11100 + + // Look from the top bottom up, and concatenate the binary strings. + // Then, convert the 8-bit groups to hex and reverse the (8-bit)byte order + + // combined, these should become (in memory), in binary: + // 10100010 11100010 11010010 11100101 + // or in hex: + // A2 E2 D2 E5 + + printf("\nBitfield order check (descriptorDummy.flMaps.flMaps0) with junk/dummy data:"); + printf("\nShould be: a2 e2 d2 e5 "); + printf("\nAnd it is: "); + + for (i = 0; i < 4; i++) { + printf("%02x ", *(flMap0Ptr + i)); + } + printf("\n"); + + if (!(*flMap0Ptr == 0xA2 && *(flMap0Ptr+1) == 0xE2 && *(flMap0Ptr+2) == 0xD2 && *(flMap0Ptr+3) == 0xE5)) { + printf("Incorrect order.\n"); + return 1; + } + printf("Correct order.\n"); + return 0; +} + +// Compatibility checks. This version of ich9deblob is not yet porable. +int systemOrCompilerIncompatible(struct DESCRIPTORREGIONRECORD descriptorStruct, struct GBEREGIONRECORD_8K gbeStruct8k) +{ + if (structSizesIncorrect(descriptorStruct, gbeStruct8k)) return 1; + if (systemIsBigEndian()) return 1; + if (structBitfieldWrongOrder()) return 1; + if (structMembersWrongOrder()) return 1; + return 0; +} -- cgit v1.2.3-70-g09d2