porting getpir to freebios2

git-svn-id: svn://svn.coreboot.org/coreboot/trunk@1500 2b7e53f0-3cfb-0310-b3e9-8179ed1497e1

util/getpir/Makefile

@@ -0,0 +1,30 @@
+# change to the path of your linuxbios tree
+#LINUXBIOSROOT=/home/rminnich/src//freebios/
+LINUXBIOSROOT=../..
+
+INCLUDEPATH=$(LINUXBIOSROOT)/src/arch/i386/include/arch
+INCLUDE2=$(LINUXBIOSROOT)/src/include
+INCLUDE3=$(LINUXBIOSROOT)/src/arch/i386/include
+
+
+getpir: getpir.c
+	gcc -o getpir -I$(INCLUDEPATH) -I$(INCLUDE2) getpir.c
+
+checkpir: checkpir.c irq_tables.o
+	gcc -o checkpir -I$(INCLUDEPATH) -I$(INCLUDE2) irq_tables.o checkpir.c
+
+assignirq: assignirq.c irq_tables.o
+	gcc -g -o assignirq -I$(INCLUDEPATH) -I$(INCLUDE2) assignirq.c -lpci
+
+irq_tables.o: irq_tables.c  
+	gcc -c -I$(INCLUDEPATH) -I$(INCLUDE2) -I$(INCLUDE3) irq_tables.c
+
+clean:
+	rm -f irq_tables.o getpir checkpir assignirq *~
+
+cleantable:
+	rm -f irq_table.o
+
+test:   checkpir
+	./checkpir ;\
+	exit 0;

util/getpir/README

@@ -0,0 +1,28 @@
+ABOUT:
+
+This utility will help to create irq_table.c file, that is very hard to create manually, 
+specialy when you are testing new motherboards, changing your hardware often, placing new cards, etc.. 
+
+
+INSTALL:
+
+edit Makefile, define the root to Linuxbios tree
+make
+
+USAGE:
+
+./getpir
+
+Will dump irq table to the file called irq_tables.c, ready to use with Linuxbios. Just move the 
+file to corresponding place in the linux bios tree.
+
+
+CHECKING CUSTOM irq_tables.c:
+
+checkpir.c Will verify the irq_tables.c, currently it only checks the checksum. In case of wrong
+checksum, a good value is proposed, so you can edit irq_tables.c manualy and replace checksum.
+Run the command like this:
+
+make test
+
+Do not run ./checkpir directly because it needs to be linked to irq_table.o first.

util/getpir/checkpir.c

@@ -0,0 +1,48 @@
+/* checkpir.c : This software is released under GPL
+   For Linuxbios use only
+   Aug 26 2001 , Nikolai Vladychevski, <niko@isl.net.mx>
+*/
+
+#include <unistd.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <device/pci.h>
+#include <pirq_routing.h>
+
+#define PIRQ_SIGNATURE  (('$' << 0) + ('P' << 8) + ('I' << 16) + ('R' << 24))
+#define PIRQ_VERS 0x0100
+
+struct irq_info se_arr[50];
+struct irq_routing_table *rt;
+
+int calc_checksum(struct irq_routing_table *rt)
+{
+	long sum = 0, i;
+	uint8_t *addr, sum2 = 0;
+
+	addr = (uint8_t *) rt;
+	for (i = 0; i < rt->size; i++)
+		sum2 += addr[i];
+	return (sum2);
+}
+
+main()
+{
+	uint8_t sum, newsum;
+
+	rt = (struct irq_routing_table *) &intel_irq_routing_table;
+	sum = calc_checksum(rt);
+
+	printf("Validating checksum, file: irq_tables.c that was in ./ at compile time...\n");
+	printf("(no other tests are done)\n");
+
+	if (!sum) {
+		printf("Checksum for IRQ Routing table is ok. You can use it in LinuxBios now\n");
+	} else {
+		newsum = rt->checksum - sum;
+		printf("BAD CHECKSUM for IRQ Routing table !!!!\n");
+		printf("If you want to make it valid, change the checksum to: %#x\n",
+		       newsum);
+	}
+}

util/getpir/getpir.c

@@ -0,0 +1,153 @@
+/* getpir.c : This software is released under GPL
+   For Linuxbios use only
+   Aug 26 2001 , Nikolai Vladychevski, <niko@isl.net.mx>
+*/
+
+#include <unistd.h>
+#include <stdio.h>
+#include <string.h>
+
+#include <device/pci.h>
+#include <pirq_routing.h>
+
+#define PIRQ_SIGNATURE  (('$' << 0) + ('P' << 8) + ('I' << 16) + ('R' << 24))
+#define PIRQ_VERS 0x0100
+
+struct irq_info se_arr[50];
+struct irq_routing_table rt;
+unsigned short ts;
+
+
+int calc_checksum()
+{
+	long sum = 0, i, j;
+	uint8_t *addr, sum2 = 0, data;
+
+	addr = (uint8_t *) & rt;
+	for (i = 0; i < sizeof(struct irq_routing_table); i++)
+		sum2 += addr[i];
+	for (i = 0; i < ts; i++) {
+		addr = (uint8_t *) & se_arr[i];
+		for (j = 0; j < sizeof(struct irq_info); j++)
+			sum2 += addr[j];
+	}
+	return (sum2);
+}
+
+main()
+{
+	FILE *fmem, *fpir;
+	size_t rcount = 0;
+	unsigned long b, p, pir = PIRQ_SIGNATURE;
+	unsigned long count;
+	int i, valid = 1, print = 0;
+	char cksum = 0;
+	unsigned char *ptr;
+
+	if (getuid()) {
+		perror("Run me as root, I need access to /dev/mem");
+		exit(1);
+	}
+
+	printf("Opening memory...\n");
+	fmem = fopen("/dev/mem", "r");
+	do {
+		rcount = fread(&b, 1, 4, fmem);
+		if (rcount > 0) {
+			if (b == pir) {
+				valid = 1;
+				printf("Found PCI IRQ Routing table signature at %x bytes from top of the memory\nValidating../\n",
+				       count);
+				rt.signature = PIRQ_SIGNATURE;
+				ptr = (char *) &rt;
+				ptr = ptr + 4;	// signature was read, advance 4 bytes
+				rcount = fread(ptr, 1, sizeof(struct irq_routing_table) - 4, fmem);
+				count = count + rcount;
+				printf("Version is:%d Table size:%d\n",
+				       rt.version, rt.size);
+				if (rt.version != PIRQ_VERS) {
+					printf("Invalid version\n");
+					valid = 0;
+				}
+				if (rt.size < 32) {
+					printf(" Invalid table size\n");
+					valid = 0;
+				}
+				if (rt.size % 16) {
+					printf(" Invalid table size (not a multiple of 16)\n");
+					valid = 0;
+				}
+				if (valid) {
+					//      read slot entries
+					ts = (rt.size - 32) / 16;
+					printf("Reading %d slot entries...\n", ts);
+					for (i = 0; i < ts; i++) {
+						rcount =
+						    fread(&se_arr[i], 1, 16, fmem);
+						count = count + rcount;
+					}
+					print = 1;
+					break;
+				}
+			} else {
+				count = count + rcount;
+			}
+		}
+	} while (rcount > 0);
+
+	if (!calc_checksum())
+		printf("Checksum is ok!\n");
+	printf("Closing memory\n");
+	fclose(fmem);
+
+	if (!print) {
+		printf("No table for you...\n");
+		return (0);
+	}
+
+	printf("Creating irq_tables.c .....\n");
+	fpir = fopen("irq_tables.c", "w");
+	if (!fpir) {
+		printf("Failed creating file!\n");
+		exit(2);
+	}
+
+	fprintf(fpir, "/* This file was generated by getpir.c, do not modify! \n   (but if you do, please run checkpir on it to verify)\n");
+	fprintf(fpir, "   Contains the IRQ Routing Table dumped directly from your memory , wich BIOS sets up\n\n");
+	fprintf(fpir, "   Documentation at : http://www.microsoft.com/hwdev/busbios/PCIIRQ.HTM\n*/\n\n");
+	fprintf(fpir, "#include <arch/pirq_routing.h>\n\n");
+	fprintf(fpir, "const struct irq_routing_table intel_irq_routing_table = {\n");
+	fprintf(fpir, "\tPIRQ_SIGNATURE,  /* u32 signature */\n");
+	fprintf(fpir, "\tPIRQ_VERSION,    /* u16 version   */\n");
+	fprintf(fpir, "\t32+16*%d,	 /* there can be total %d devices on the bus */\n",
+		ts, ts);
+	fprintf(fpir, "\t0x%02x,		 /* Where the interrupt router lies (bus) */\n",
+		rt.rtr_bus);
+	fprintf(fpir, "\t(0x%02x<<3)|0x%01x,   /* Where the interrupt router lies (dev) */\n",
+		rt.rtr_devfn >> 3, rt.rtr_devfn & 7);
+	fprintf(fpir, "\t%#x,		 /* IRQs devoted exclusively to PCI usage */\n",
+		rt.exclusive_irqs);
+	fprintf(fpir, "\t%#x,		 /* Vendor */\n", rt.rtr_vendor);
+	fprintf(fpir, "\t%#x,		 /* Device */\n", rt.rtr_device);
+	fprintf(fpir, "\t%#x,		 /* Crap (miniport) */\n",
+		rt.miniport_data);
+	fprintf(fpir, "\t{ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 }, /* u8 rfu[11] */\n");
+	fprintf(fpir, "\t%#x,         /*  u8 checksum , this hase to set to some value that would give 0 after the sum of all bytes for this structure (including checksum) */\n",
+		rt.checksum);
+	fprintf(fpir, "\t{\n");
+	fprintf(fpir, "\t\t/* bus,     dev|fn,   {link, bitmap}, {link, bitmap}, {link, bitmap}, {link, bitmap},  slot, rfu */\n");
+	for (i = 0; i < ts; i++) {
+		fprintf(fpir, "\t\t{0x%02x,(0x%02x<<3)|0x%01x, {{0x%02x, 0x%04x}, {0x%02x, 0x%04x}, {0x%02x, 0x%04x}, {0x%02x, 0x0%04x}}, 0x%x, 0x%x},\n",
+			se_arr[i].bus, se_arr[i].devfn >> 3,
+			se_arr[i].devfn & 7, se_arr[i].irq[0].link,
+			se_arr[i].irq[0].bitmap, se_arr[i].irq[1].link,
+			se_arr[i].irq[1].bitmap, se_arr[i].irq[2].link,
+			se_arr[i].irq[2].bitmap, se_arr[i].irq[3].link,
+			se_arr[i].irq[3].bitmap, se_arr[i].slot,
+			se_arr[i].rfu);
+	}
+	fprintf(fpir, "\t}\n");
+	fprintf(fpir, "};\n");
+	fclose(fpir);
+	printf("Done, you can move the file to the LinuxBios tree now.\n");
+}

util/newconfig/config.g

@@ -1941,6 +1941,42 @@ def writeldoptions(image):
 			file.write("%s = %s;\n" % (o.name, getformated(o.name, image)))
 	file.close()
 
+# Write doxygen file.
+def writedoxygenfile(image):
+	doxyscriptbase = os.path.join(treetop, "src/config/doxyscript.base")
+	doxyfilepath = os.path.join(image.gettargetdir(), "LinuxBIOSDoc.config")
+	print "Creating", doxyfilepath
+	file = safe_open(doxyfilepath, 'w+')
+
+# FIXME. Should be computing .c once. Fix this in objectrules.append
+	file.write("INPUT= \\\n")
+	for irule, init in image.getinitobjectrules().items():
+		source = init[1]
+		if (source[-2:] != '.c'): # no suffix. Build name.
+			base = init[0][:-2]
+			source = os.path.join(source, base) + ".c"
+		file.write("%s \\\n" % source)
+	for objrule, obj in image.getobjectrules().items():
+		source = obj[1]
+		if (source[-2:] != '.c'): # no suffix. Build name.
+			base = obj[0][:-2]
+			source = os.path.join(source, base) + ".c"
+		file.write("%s \\\n" % source)
+	for driverrule, driver in image.getdriverrules().items():
+		source = driver[1]
+		if (source[-2:] != '.c'): # no suffix. Build name.
+			base = driver[0][:-2]
+			source = os.path.join(source, base) + ".c"
+		file.write("%s \\\n" % source)
+
+	fp = safe_open(doxyscriptbase, 'r')
+	doxylines = fp.readlines()
+	if (debug):
+		print "DOXYLINES ",doxylines
+        for line in doxylines:
+		file.write(line)
+	file.close();
+
 def dumptree(part, lvl):
 	debug.info(debug.dumptree, "DUMPTREE ME is")
 	part.dumpme(lvl)
@@ -2056,6 +2092,7 @@ if __name__=='__main__':
 		writeinitincludes(image)
 		writeimagemakefile(image)
 		writeldoptions(image)
+		writedoxygenfile(image)
 
 	writemakefilesettings(target_dir)
 	writemakefile(target_dir)