X-Git-Url: http://cvs.zerfleddert.de/cgi-bin/gitweb.cgi/proxmark3-svn/blobdiff_plain/015520dc4e90a6ef672590049e807d569794ef81..437035a75b2737d0b36886bc2bacaeb0219c6325:/client/fpga_compress.c

diff --git a/client/fpga_compress.c b/client/fpga_compress.c
index aacafc86..418a02b8 100644
--- a/client/fpga_compress.c
+++ b/client/fpga_compress.c
@@ -1,4 +1,6 @@
 //-----------------------------------------------------------------------------
+// piwi, 2017, 2018
+//
 // This code is licensed to you under the terms of the GNU GPL, version 2 or,
 // at your option, any later version. See the LICENSE.txt file for the text of
 // the license.
@@ -11,9 +13,11 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <libgen.h>
 #include <string.h>
 #include <stdint.h>
 #include <stdbool.h>
+#include "fpga.h"
 #include "zlib.h"
 
 #define MAX(a,b) ((a)>(b)?(a):(b))
@@ -28,7 +32,8 @@
 	Z_HUFFMAN_ONLY (huffman only, no string matching)
 	Z_RLE (distances limited to one)
 	Z_FIXED (prevents the use of dynamic Huffman codes)
-*/	
+*/
+
 #define	COMPRESS_STRATEGY       Z_DEFAULT_STRATEGY
 // zlib tuning parameters:
 #define COMPRESS_GOOD_LENGTH           258
@@ -36,15 +41,18 @@
 #define COMPRESS_MAX_NICE_LENGTH       258
 #define COMPRESS_MAX_CHAIN            8192
 
-#define FPGA_INTERLEAVE_SIZE           288  // (the FPGA's internal config frame size is 288 bits. Interleaving with 288 bytes should give best compression)
-#define FPGA_CONFIG_SIZE             42336  // our current fpga_[lh]f.bit files are 42175 bytes. Rounded up to next multiple of FPGA_INTERLEAVE_SIZE
+#define HARDNESTED_TABLE_SIZE		(sizeof(uint32_t) * ((1L<<19)+1))
 
 static void usage(void)
 {
-	fprintf(stderr, "Usage: fpga_compress <infile1> <infile2> ... <infile_n> <outfile>\n");
-	fprintf(stderr, "          Combine n FPGA bitstream files and compress them into one.\n\n");
-	fprintf(stderr, "       fpga_compress -d <infile> <outfile>");
-	fprintf(stderr, "          Decompress <infile>. Write result to <outfile>");
+	fprintf(stdout, "Usage: fpga_compress <infile1> <infile2> ... <infile_n> <outfile>\n");
+	fprintf(stdout, "          Combine n FPGA bitstream files and compress them into one.\n\n");
+	fprintf(stdout, "       fpga_compress -v <infile1> <infile2> ... <infile_n> <outfile>\n");
+	fprintf(stdout, "          Extract Version Information from FPGA bitstream files and write it to <outfile>\n\n");
+	fprintf(stdout, "       fpga_compress -d <infile> <outfile>\n");
+	fprintf(stdout, "          Decompress <infile>. Write result to <outfile>\n\n");
+	fprintf(stdout, "       fpga_compress -t <infile> <outfile>\n");
+	fprintf(stdout, "          Compress hardnested table <infile>. Write result to <outfile>\n\n");
 }
 
 
@@ -56,7 +64,7 @@ static voidpf fpga_deflate_malloc(voidpf opaque, uInt items, uInt size)
 
 static void fpga_deflate_free(voidpf opaque, voidpf address)
 {
-	return free(address);
+	free(address);
 }
 
 
@@ -72,22 +80,29 @@ static bool all_feof(FILE *infile[], uint8_t num_infiles)
 }
 
 
-int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile)
+int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile, bool hardnested_mode)
 {
 	uint8_t *fpga_config;
 	uint32_t i;
-	int ret;
-	uint8_t c;		
+	int32_t ret;
+	uint8_t c;
 	z_stream compressed_fpga_stream;
 
-	fpga_config = malloc(num_infiles * FPGA_CONFIG_SIZE);
-	
+	if (hardnested_mode) {
+		fpga_config = malloc(num_infiles * HARDNESTED_TABLE_SIZE);
+	} else {
+		fpga_config = malloc(num_infiles * FPGA_CONFIG_SIZE);
+	}		
 	// read the input files. Interleave them into fpga_config[]
 	i = 0;
 	do {
 
-		if (i >= num_infiles * FPGA_CONFIG_SIZE) {
-			fprintf(stderr, "Input files too big (total > %d bytes). These are probably not PM3 FPGA config files.\n", num_infiles*FPGA_CONFIG_SIZE);
+		if (i >= num_infiles * (hardnested_mode?HARDNESTED_TABLE_SIZE:FPGA_CONFIG_SIZE)) {
+			if (hardnested_mode) {
+				fprintf(stderr, "Input file too big (> %lu bytes). This is probably not a hardnested bitflip state table.\n", HARDNESTED_TABLE_SIZE);
+			} else {
+				fprintf(stderr, "Input files too big (total > %lu bytes). These are probably not PM3 FPGA config files.\n", num_infiles*FPGA_CONFIG_SIZE);
+			}
 			for(uint16_t j = 0; j < num_infiles; j++) {
 				fclose(infile[j]);
 			}
@@ -97,7 +112,7 @@ int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile)
 
 		for(uint16_t j = 0; j < num_infiles; j++) {
 			for(uint16_t k = 0; k < FPGA_INTERLEAVE_SIZE; k++) {
-				c = fgetc(infile[j]);
+				c = (uint8_t)fgetc(infile[j]);
 				if (!feof(infile[j])) {
 					fpga_config[i++] = c;
 				} else if (num_infiles > 1) {
@@ -122,11 +137,11 @@ int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile)
 						COMPRESS_STRATEGY);
 
 	// estimate the size of the compressed output
-	unsigned int outsize_max = deflateBound(&compressed_fpga_stream, compressed_fpga_stream.avail_in);
+	uint32_t outsize_max = deflateBound(&compressed_fpga_stream, compressed_fpga_stream.avail_in);
 	uint8_t *outbuf = malloc(outsize_max);
 	compressed_fpga_stream.next_out = outbuf;
 	compressed_fpga_stream.avail_out = outsize_max;
-					
+        
 	if (ret == Z_OK) {
 		ret = deflateTune(&compressed_fpga_stream,
 							COMPRESS_GOOD_LENGTH,
@@ -139,10 +154,10 @@ int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile)
 		ret = deflate(&compressed_fpga_stream, Z_FINISH);
 	}
 	
-	fprintf(stderr, "compressed %d input bytes to %lu output bytes\n", i, compressed_fpga_stream.total_out);
+	fprintf(stdout, "compressed %u input bytes to %lu output bytes\n", i, compressed_fpga_stream.total_out);
 
 	if (ret != Z_STREAM_END) {
-		fprintf(stderr, "Error in deflate(): %d %s\n", ret, compressed_fpga_stream.msg);
+		fprintf(stderr, "Error in deflate(): %i %s\n", ret, compressed_fpga_stream.msg);
 		free(outbuf);
 		deflateEnd(&compressed_fpga_stream);
 		for(uint16_t j = 0; j < num_infiles; j++) {
@@ -177,7 +192,7 @@ int zlib_decompress(FILE *infile, FILE *outfile)
 	#define DECOMPRESS_BUF_SIZE 1024
 	uint8_t outbuf[DECOMPRESS_BUF_SIZE];
 	uint8_t inbuf[DECOMPRESS_BUF_SIZE];
-	int ret;
+	int32_t ret;
 	
 	z_stream compressed_fpga_stream;
 
@@ -197,7 +212,7 @@ int zlib_decompress(FILE *infile, FILE *outfile)
 			compressed_fpga_stream.next_in = inbuf;
 			uint16_t i = 0;
 			do {
-				int c = fgetc(infile);
+				int32_t c = fgetc(infile);
 				if (!feof(infile)) {
 					inbuf[i++] = c & 0xFF;
 					compressed_fpga_stream.avail_in++;
@@ -232,7 +247,7 @@ int zlib_decompress(FILE *infile, FILE *outfile)
 		fclose(infile);
 		return(EXIT_SUCCESS);
 	} else {
-		fprintf(stderr, "Error. Inflate() returned error %d, %s", ret, compressed_fpga_stream.msg);
+		fprintf(stderr, "Error. Inflate() returned error %i, %s", ret, compressed_fpga_stream.msg);
 		fclose(outfile);
 		fclose(infile);
 		return(EXIT_FAILURE);
@@ -241,9 +256,162 @@ int zlib_decompress(FILE *infile, FILE *outfile)
 }
 
 
+/* Simple Xilinx .bit parser. The file starts with the fixed opaque byte sequence
+ * 00 09 0f f0 0f f0 0f f0 0f f0 00 00 01
+ * After that the format is 1 byte section type (ASCII character), 2 byte length
+ * (big endian), <length> bytes content. Except for section 'e' which has 4 bytes
+ * length.
+ */
+static int bitparse_find_section(FILE *infile, char section_name, unsigned int *section_length)
+{
+	int result = 0;
+	#define MAX_FPGA_BIT_STREAM_HEADER_SEARCH 100  // maximum number of bytes to search for the requested section
+	uint16_t numbytes = 0;
+	while(numbytes < MAX_FPGA_BIT_STREAM_HEADER_SEARCH) {
+		char current_name = (char)fgetc(infile);
+		numbytes++;
+		if(current_name < 'a' || current_name > 'e') {
+			/* Strange section name, abort */
+			break;
+		}
+		unsigned int current_length = 0;
+		switch(current_name) {
+		case 'e':
+			/* Four byte length field */
+			current_length += fgetc(infile) << 24;
+			current_length += fgetc(infile) << 16;
+			numbytes += 2;
+		default: /* Fall through, two byte length field */
+			current_length += fgetc(infile) << 8;
+			current_length += fgetc(infile) << 0;
+			numbytes += 2;
+		}
+
+		if(current_name != 'e' && current_length > 255) {
+			/* Maybe a parse error */
+			break;
+		}
+
+		if(current_name == section_name) {
+			/* Found it */
+			*section_length = current_length;
+			result = 1;
+			break;
+		}
+
+		for (uint16_t i = 0; i < current_length && numbytes < MAX_FPGA_BIT_STREAM_HEADER_SEARCH; i++) {
+			(void)fgetc(infile);
+			numbytes++;
+		}
+	}
+
+	return result;
+}
+
+
+static int FpgaGatherVersion(FILE *infile, char* infile_name, char *dst, int len)
+{
+	unsigned int fpga_info_len;
+	char tempstr[40] = {0x00};
+	
+	dst[0] = '\0';
+
+	for (uint16_t i = 0; i < FPGA_BITSTREAM_FIXED_HEADER_SIZE; i++) {
+		if (fgetc(infile) != bitparse_fixed_header[i]) {
+			fprintf(stderr, "Invalid FPGA file. Aborting...\n\n");
+			return(EXIT_FAILURE);
+		}
+	}
+
+	strncat(dst, basename(infile_name), len-1);
+	// if (bitparse_find_section(infile, 'a', &fpga_info_len)) {
+		// for (uint16_t i = 0; i < fpga_info_len; i++) {
+			// char c = (char)fgetc(infile);
+			// if (i < sizeof(tempstr)) {
+				// tempstr[i] = c;
+			// }
+		// }
+		// strncat(dst, tempstr, len-1);
+	// }
+	strncat(dst, " built", len-1);
+	if (bitparse_find_section(infile, 'b', &fpga_info_len)) {
+		strncat(dst, " for ", len-1);
+		for (uint16_t i = 0; i < fpga_info_len; i++) {
+			char c = (char)fgetc(infile);
+			if (i < sizeof(tempstr)) {
+				tempstr[i] = c;
+			}
+		}
+		strncat(dst, tempstr, len-1);
+	}
+	if (bitparse_find_section(infile, 'c', &fpga_info_len)) {
+		strncat(dst, " on ", len-1);
+		for (uint16_t i = 0; i < fpga_info_len; i++) {
+			char c = (char)fgetc(infile);
+			if (i < sizeof(tempstr)) {
+				tempstr[i] = c;
+			}
+		}
+		strncat(dst, tempstr, len-1);
+	}
+	if (bitparse_find_section(infile, 'd', &fpga_info_len)) {
+		strncat(dst, " at ", len-1);
+		for (uint16_t i = 0; i < fpga_info_len; i++) {
+			char c = (char)fgetc(infile);
+			if (i < sizeof(tempstr)) {
+				tempstr[i] = c;
+			}
+		}
+		strncat(dst, tempstr, len-1);
+	}
+	return 0;
+}
+
+
+static void print_version_info_preamble(FILE *outfile, int num_infiles) {
+	fprintf(outfile, "//-----------------------------------------------------------------------------\n");
+	fprintf(outfile, "// piwi, 2018\n");
+	fprintf(outfile, "//\n");
+	fprintf(outfile, "// This code is licensed to you under the terms of the GNU GPL, version 2 or,\n");
+	fprintf(outfile, "// at your option, any later version. See the LICENSE.txt file for the text of\n");
+	fprintf(outfile, "// the license.\n");
+	fprintf(outfile, "//-----------------------------------------------------------------------------\n");
+	fprintf(outfile, "// Version information on fpga images\n");
+	fprintf(outfile, "//\n");
+	fprintf(outfile, "// This file is generated by fpga_compress. Don't edit!\n");
+	fprintf(outfile, "//-----------------------------------------------------------------------------\n");
+	fprintf(outfile, "\n");
+	fprintf(outfile, "\n");
+	fprintf(outfile, "const int fpga_bitstream_num = %d;\n", num_infiles);
+	fprintf(outfile, "const char* const fpga_version_information[%d] = {\n", num_infiles);
+}
+
+
+static int generate_fpga_version_info(FILE *infile[], char *infile_names[], int num_infiles, FILE *outfile) {
+	
+	char version_string[80] = "";
+	
+	print_version_info_preamble(outfile, num_infiles);
+	
+	for (int i = 0; i < num_infiles; i++) {
+		FpgaGatherVersion(infile[i], infile_names[i], version_string, sizeof(version_string));
+		fprintf(outfile, "\t\"%s\"", version_string);
+		if (i != num_infiles-1) {
+			fprintf(outfile, ",");
+		}
+		fprintf(outfile,"\n");
+	}
+	
+	fprintf(outfile, "};\n");
+
+	return 0;
+}	
+
+
 int main(int argc, char **argv)
 {
 	FILE **infiles;
+	char **infile_names;
 	FILE *outfile;
 	
 	if (argc == 1 || argc == 2) {
@@ -251,7 +419,8 @@ int main(int argc, char **argv)
 		return(EXIT_FAILURE);
 	}
 	
-	if (!strcmp(argv[1], "-d")) {			// Decompress
+	if (!strcmp(argv[1], "-d")) { // Decompress
+
 		infiles = calloc(1, sizeof(FILE*));
 		if (argc != 4) {
 			usage();
@@ -259,31 +428,56 @@ int main(int argc, char **argv)
 		} 
 		infiles[0] = fopen(argv[2], "rb");
 		if (infiles[0] == NULL) {
-			fprintf(stderr, "Error. Cannot open input file %s", argv[2]);
+			fprintf(stderr, "Error. Cannot open input file %s\n\n", argv[2]);
 			return(EXIT_FAILURE);
 		}
 		outfile = fopen(argv[3], "wb");
 		if (outfile == NULL) {
-			fprintf(stderr, "Error. Cannot open output file %s", argv[3]);
+			fprintf(stderr, "Error. Cannot open output file %s\n\n", argv[3]);
 			return(EXIT_FAILURE);
 		}
 		return zlib_decompress(infiles[0], outfile);
 
-	} else {								// Compress
+	} else { // Compress or gemerate version info
 
-		infiles = calloc(argc-2, sizeof(FILE*));
-		for (uint16_t i = 0; i < argc-2; i++) { 
-			infiles[i] = fopen(argv[i+1], "rb");
+		bool hardnested_mode = false;
+		bool generate_version_file = false;
+		int num_input_files = 0;
+		if (!strcmp(argv[1], "-t")) { 			// compress one hardnested table
+			if (argc != 4) {
+				usage();
+				return(EXIT_FAILURE);
+			}
+			hardnested_mode = true;
+			num_input_files = 1;
+		} else if (!strcmp(argv[1], "-v")) { 	// generate version info
+			generate_version_file = true;
+			num_input_files = argc-3;
+		} else { 								// compress 1..n fpga files
+			num_input_files = argc-2;
+		}
+			
+		infiles = calloc(num_input_files, sizeof(FILE*));
+		infile_names = calloc(num_input_files, sizeof(char*));
+		for (uint16_t i = 0; i < num_input_files; i++) {
+			infile_names[i] = argv[i+((hardnested_mode || generate_version_file)?2:1)];
+			infiles[i] = fopen(infile_names[i], "rb");
 			if (infiles[i] == NULL) {
-				fprintf(stderr, "Error. Cannot open input file %s", argv[i+1]);
+				fprintf(stderr, "Error. Cannot open input file %s\n\n", infile_names[i]);
 				return(EXIT_FAILURE);
 			}
 		}
 		outfile = fopen(argv[argc-1], "wb");
 		if (outfile == NULL) {
-			fprintf(stderr, "Error. Cannot open output file %s", argv[argc-1]);
+			fprintf(stderr, "Error. Cannot open output file %s\n\n", argv[argc-1]);
 			return(EXIT_FAILURE);
 		}
-		return zlib_compress(infiles, argc-2, outfile);
+		if (generate_version_file) {
+			if (generate_fpga_version_info(infiles, infile_names, num_input_files, outfile)) {
+				return(EXIT_FAILURE);
+			}
+		} else {
+			return zlib_compress(infiles, num_input_files, outfile, hardnested_mode);
+		}
 	}
 }