From b307eff6f026b1262433eb4d8389b774b3e0a9ff Mon Sep 17 00:00:00 2001
From: Francis Rowe <info@gluglug.org.uk>
Date: Sun, 28 Dec 2014 17:09:07 -0500
Subject: ich9gen: updated some comments

---
(limited to 'resources/utilities/ich9deblob')

diff --git a/resources/utilities/ich9deblob/src/descriptor/descriptor.c b/resources/utilities/ich9deblob/src/descriptor/descriptor.c
index 7c8aa24..3c9ef04 100644
--- a/resources/utilities/ich9deblob/src/descriptor/descriptor.c
+++ b/resources/utilities/ich9deblob/src/descriptor/descriptor.c
@@ -195,7 +195,7 @@ int notCreatedCFileFromDescriptorStruct(struct DESCRIPTORREGIONRECORD descriptor
 	fprintf(fp, "    descriptorStruct.flMaps.flMap0.NC = 0x%01x;\n", descriptorStruct.flMaps.flMap0.NC);
 	fprintf(fp, "    descriptorStruct.flMaps.flMap0.reserved1 = 0x%02x;\n", descriptorStruct.flMaps.flMap0.reserved1);
 	fprintf(fp, "    descriptorStruct.flMaps.flMap0.FRBA = 0x%02x;\n", descriptorStruct.flMaps.flMap0.FRBA);
-	fprintf(fp, "    descriptorStruct.flMaps.flMap0.NR = 0x%01x;\n", descriptorStruct.flMaps.flMap0.NR);
+	fprintf(fp, "    descriptorStruct.flMaps.flMap0.NR = 0x%01x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.flMaps.flMap0.NR);
 	fprintf(fp, "    descriptorStruct.flMaps.flMap0.reserved2 = 0x%02x;\n", descriptorStruct.flMaps.flMap0.reserved2);
 	fprintf(fp, "    /* FLMAP1 */\n");
 	fprintf(fp, "    descriptorStruct.flMaps.flMap1.FMBA = 0x%02x;\n", descriptorStruct.flMaps.flMap1.FMBA);
@@ -249,24 +249,24 @@ int notCreatedCFileFromDescriptorStruct(struct DESCRIPTORREGIONRECORD descriptor
 	fprintf(fp, "    descriptorStruct.regionSection.flReg0.LIMIT = 0x%04x;\n", descriptorStruct.regionSection.flReg0.LIMIT);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg0.reserved2 = 0x%01x;\n", descriptorStruct.regionSection.flReg0.reserved2);
 	fprintf(fp, "    /* FLREG1 (BIOS) */\n");
-	fprintf(fp, "    descriptorStruct.regionSection.flReg1.BASE = 0x%04x;\n", descriptorStruct.regionSection.flReg1.BASE);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg1.BASE = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg1.BASE);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg1.reserved1 = 0x%01x;\n", descriptorStruct.regionSection.flReg1.reserved1);
-	fprintf(fp, "    descriptorStruct.regionSection.flReg1.LIMIT = ((romSize >> FLREGIONBITSHIFT) - 1);\n");
+	fprintf(fp, "    descriptorStruct.regionSection.flReg1.LIMIT = ((romSize >> FLREGIONBITSHIFT) - 1); /* see ../descriptor/descriptor.c */\n");
 	fprintf(fp, "    descriptorStruct.regionSection.flReg1.reserved2 = 0x%01x;\n", descriptorStruct.regionSection.flReg1.reserved2);
 	fprintf(fp, "    /* FLREG2 (ME) */\n");
-	fprintf(fp, "    descriptorStruct.regionSection.flReg2.BASE = 0x%04x; /* 0x1FFF to disable */\n", descriptorStruct.regionSection.flReg2.BASE);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg2.BASE = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg2.BASE);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg2.reserved1 = 0x%01x;\n", descriptorStruct.regionSection.flReg2.reserved1);
-	fprintf(fp, "    descriptorStruct.regionSection.flReg2.LIMIT = 0x%04x; /* 0x0000 to disable */\n", descriptorStruct.regionSection.flReg2.LIMIT);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg2.LIMIT = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg2.LIMIT);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg2.reserved2 = 0x%01x;\n", descriptorStruct.regionSection.flReg2.reserved2);
 	fprintf(fp, "    /* FLREG3 (Gbe) */\n");
-	fprintf(fp, "    descriptorStruct.regionSection.flReg3.BASE = 0x%04x;\n", descriptorStruct.regionSection.flReg3.BASE);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg3.BASE = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg3.BASE);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg3.reserved1 = 0x%01x;\n", descriptorStruct.regionSection.flReg3.reserved1);
-	fprintf(fp, "    descriptorStruct.regionSection.flReg3.LIMIT = 0x%04x;\n", descriptorStruct.regionSection.flReg3.LIMIT);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg3.LIMIT = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg3.LIMIT);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg3.reserved2 = 0x%01x;\n", descriptorStruct.regionSection.flReg3.reserved2);
 	fprintf(fp, "    /* FLREG4 (Platform) */\n");
-	fprintf(fp, "    descriptorStruct.regionSection.flReg4.BASE = 0x%04x; /* 0x1FFF to disable */\n", descriptorStruct.regionSection.flReg4.BASE);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg4.BASE = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg4.BASE);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg4.reserved1 = 0x%01x;\n", descriptorStruct.regionSection.flReg4.reserved1);
-	fprintf(fp, "    descriptorStruct.regionSection.flReg4.LIMIT = 0x%04x; /* 0x0000 to disable */\n", descriptorStruct.regionSection.flReg4.LIMIT);
+	fprintf(fp, "    descriptorStruct.regionSection.flReg4.LIMIT = 0x%04x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.regionSection.flReg4.LIMIT);
 	fprintf(fp, "    descriptorStruct.regionSection.flReg4.reserved2 = 0x%01x;\n", descriptorStruct.regionSection.flReg4.reserved2);
 	fprintf(fp, "    /* Padding */\n");
 	for (i = 0; i < 12; i++) {
@@ -293,7 +293,7 @@ int notCreatedCFileFromDescriptorStruct(struct DESCRIPTORREGIONRECORD descriptor
 	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.gbeRegionReadAccess = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.gbeRegionReadAccess);
 	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.pdRegionReadAccess = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.pdRegionReadAccess);
 	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.reserved1 = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.reserved1);
-	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.fdRegionWriteAccess = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.fdRegionWriteAccess);
+	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.fdRegionWriteAccess = 0x%01x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.masterAccessSection.flMstr1.fdRegionWriteAccess);
 	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.biosRegionWriteAccess = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.biosRegionWriteAccess);
 	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.meRegionWriteAccess = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.meRegionWriteAccess);
 	fprintf(fp, "    descriptorStruct.masterAccessSection.flMstr1.gbeRegionWriteAccess = 0x%01x;\n", descriptorStruct.masterAccessSection.flMstr1.gbeRegionWriteAccess);
@@ -345,7 +345,7 @@ int notCreatedCFileFromDescriptorStruct(struct DESCRIPTORREGIONRECORD descriptor
 	/* ICH straps */
 	fprintf(fp, "    /* ICH straps */\n");
 	fprintf(fp, "    /* ICHSTRAP0 */\n");
-	fprintf(fp, "    descriptorStruct.ichStraps.ichStrap0.meDisable = 0x%01x;\n", descriptorStruct.ichStraps.ichStrap0.meDisable);
+	fprintf(fp, "    descriptorStruct.ichStraps.ichStrap0.meDisable = 0x%01x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.ichStraps.ichStrap0.meDisable);
 	fprintf(fp, "    descriptorStruct.ichStraps.ichStrap0.reserved1 = 0x%02x;\n", descriptorStruct.ichStraps.ichStrap0.reserved1);
 	fprintf(fp, "    descriptorStruct.ichStraps.ichStrap0.tcoMode = 0x%01x;\n", descriptorStruct.ichStraps.ichStrap0.tcoMode);
 	fprintf(fp, "    descriptorStruct.ichStraps.ichStrap0.smBusAddress = 0x%02x;\n", descriptorStruct.ichStraps.ichStrap0.smBusAddress);
@@ -384,9 +384,9 @@ int notCreatedCFileFromDescriptorStruct(struct DESCRIPTORREGIONRECORD descriptor
 	/* MCH straps */
 	fprintf(fp, "    /* MCH straps */\n");
 	fprintf(fp, "    /* MCHSTRAP0 */\n");
-	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.meDisable = 0x%01x;\n", descriptorStruct.mchStraps.mchStrap0.meDisable);
+	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.meDisable = 0x%01x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.mchStraps.mchStrap0.meDisable);
 	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.meBootFromFlash = 0x%01x;\n", descriptorStruct.mchStraps.mchStrap0.meBootFromFlash);
-	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.tpmDisable = 0x%01x;\n", descriptorStruct.mchStraps.mchStrap0.tpmDisable);
+	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.tpmDisable = 0x%01x; /* see ../descriptor/descriptor.c */\n", descriptorStruct.mchStraps.mchStrap0.tpmDisable);
 	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.reserved1 = 0x%01x;\n", descriptorStruct.mchStraps.mchStrap0.reserved1);
 	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.spiFingerprint = 0x%01x;\n", descriptorStruct.mchStraps.mchStrap0.spiFingerprint);
 	fprintf(fp, "    descriptorStruct.mchStraps.mchStrap0.meAlternateDisable = 0x%01x;\n", descriptorStruct.mchStraps.mchStrap0.meAlternateDisable);
diff --git a/resources/utilities/ich9deblob/src/ich9gen/mkdescriptor.c b/resources/utilities/ich9deblob/src/ich9gen/mkdescriptor.c
index b9ad4f2..91f4ed4 100644
--- a/resources/utilities/ich9deblob/src/ich9gen/mkdescriptor.c
+++ b/resources/utilities/ich9deblob/src/ich9gen/mkdescriptor.c
@@ -34,7 +34,7 @@ struct DESCRIPTORREGIONRECORD generatedDescriptorStruct(unsigned int romSize)
     descriptorStruct.flMaps.flMap0.NC = 0x0;
     descriptorStruct.flMaps.flMap0.reserved1 = 0x00;
     descriptorStruct.flMaps.flMap0.FRBA = 0x04;
-    descriptorStruct.flMaps.flMap0.NR = 0x2;
+    descriptorStruct.flMaps.flMap0.NR = 0x2; /* see ../descriptor/descriptor.c */
     descriptorStruct.flMaps.flMap0.reserved2 = 0x00;
     /* FLMAP1 */
     descriptorStruct.flMaps.flMap1.FMBA = 0x06;
@@ -76,24 +76,24 @@ struct DESCRIPTORREGIONRECORD generatedDescriptorStruct(unsigned int romSize)
     descriptorStruct.regionSection.flReg0.LIMIT = 0x0000;
     descriptorStruct.regionSection.flReg0.reserved2 = 0x0;
     /* FLREG1 (BIOS) */
-    descriptorStruct.regionSection.flReg1.BASE = 0x0003;
+    descriptorStruct.regionSection.flReg1.BASE = 0x0003; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg1.reserved1 = 0x0;
-    descriptorStruct.regionSection.flReg1.LIMIT = ((romSize >> FLREGIONBITSHIFT) - 1);
+    descriptorStruct.regionSection.flReg1.LIMIT = ((romSize >> FLREGIONBITSHIFT) - 1); /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg1.reserved2 = 0x0;
     /* FLREG2 (ME) */
-    descriptorStruct.regionSection.flReg2.BASE = 0x1fff; /* 0x1FFF to disable */
+    descriptorStruct.regionSection.flReg2.BASE = 0x1fff; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg2.reserved1 = 0x0;
-    descriptorStruct.regionSection.flReg2.LIMIT = 0x0000; /* 0x0000 to disable */
+    descriptorStruct.regionSection.flReg2.LIMIT = 0x0000; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg2.reserved2 = 0x0;
     /* FLREG3 (Gbe) */
-    descriptorStruct.regionSection.flReg3.BASE = 0x0001;
+    descriptorStruct.regionSection.flReg3.BASE = 0x0001; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg3.reserved1 = 0x0;
-    descriptorStruct.regionSection.flReg3.LIMIT = 0x0002;
+    descriptorStruct.regionSection.flReg3.LIMIT = 0x0002; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg3.reserved2 = 0x0;
     /* FLREG4 (Platform) */
-    descriptorStruct.regionSection.flReg4.BASE = 0x1fff; /* 0x1FFF to disable */
+    descriptorStruct.regionSection.flReg4.BASE = 0x1fff; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg4.reserved1 = 0x0;
-    descriptorStruct.regionSection.flReg4.LIMIT = 0x0000; /* 0x0000 to disable */
+    descriptorStruct.regionSection.flReg4.LIMIT = 0x0000; /* see ../descriptor/descriptor.c */
     descriptorStruct.regionSection.flReg4.reserved2 = 0x0;
     /* Padding */
     for (i = 0; i < 12; i++) {
@@ -109,7 +109,7 @@ struct DESCRIPTORREGIONRECORD generatedDescriptorStruct(unsigned int romSize)
     descriptorStruct.masterAccessSection.flMstr1.gbeRegionReadAccess = 0x1;
     descriptorStruct.masterAccessSection.flMstr1.pdRegionReadAccess = 0x1;
     descriptorStruct.masterAccessSection.flMstr1.reserved1 = 0x0;
-    descriptorStruct.masterAccessSection.flMstr1.fdRegionWriteAccess = 0x1;
+    descriptorStruct.masterAccessSection.flMstr1.fdRegionWriteAccess = 0x1; /* see ../descriptor/descriptor.c */
     descriptorStruct.masterAccessSection.flMstr1.biosRegionWriteAccess = 0x1;
     descriptorStruct.masterAccessSection.flMstr1.meRegionWriteAccess = 0x0;
     descriptorStruct.masterAccessSection.flMstr1.gbeRegionWriteAccess = 0x1;
@@ -150,7 +150,7 @@ struct DESCRIPTORREGIONRECORD generatedDescriptorStruct(unsigned int romSize)
 
     /* ICH straps */
     /* ICHSTRAP0 */
-    descriptorStruct.ichStraps.ichStrap0.meDisable = 0x1;
+    descriptorStruct.ichStraps.ichStrap0.meDisable = 0x1; /* see ../descriptor/descriptor.c */
     descriptorStruct.ichStraps.ichStrap0.reserved1 = 0x04;
     descriptorStruct.ichStraps.ichStrap0.tcoMode = 0x1;
     descriptorStruct.ichStraps.ichStrap0.smBusAddress = 0x64;
@@ -178,9 +178,9 @@ struct DESCRIPTORREGIONRECORD generatedDescriptorStruct(unsigned int romSize)
 
     /* MCH straps */
     /* MCHSTRAP0 */
-    descriptorStruct.mchStraps.mchStrap0.meDisable = 0x1;
+    descriptorStruct.mchStraps.mchStrap0.meDisable = 0x1; /* see ../descriptor/descriptor.c */
     descriptorStruct.mchStraps.mchStrap0.meBootFromFlash = 0x0;
-    descriptorStruct.mchStraps.mchStrap0.tpmDisable = 0x1;
+    descriptorStruct.mchStraps.mchStrap0.tpmDisable = 0x1; /* see ../descriptor/descriptor.c */
     descriptorStruct.mchStraps.mchStrap0.reserved1 = 0x7;
     descriptorStruct.mchStraps.mchStrap0.spiFingerprint = 0x1;
     descriptorStruct.mchStraps.mchStrap0.meAlternateDisable = 0x0;
--
cgit v0.9.1