fpga_compress: interleave (combine) fpga_lf.bit and fpga_hf.bit before compression.
[proxmark3-svn] / client / fpga_compress.c
index db1ef81b6a0fd27cd7ca04d6fb29e5d10c8a2138..d4376ccc96a1cdc50f92bcc21e1ba0f258639005 100644 (file)
 #include <stdlib.h>
 #include <string.h>
 #include <stdint.h>
+#include <stdbool.h>
 #include "zlib.h"
 
 #define MAX(a,b) ((a)>(b)?(a):(b))
 
 // zlib configuration
 #define COMPRESS_LEVEL                 9               // use best possible compression
-
-#define FPGA_CONFIG_SIZE       42175
-static uint8_t fpga_config[FPGA_CONFIG_SIZE];
+#define COMPRESS_WINDOW_BITS   15              // default = 15 for a window of 2^15 = 32KBytes
+#define COMPRESS_MEM_LEVEL             9               // determines the amount of memory allocated during compression. Default = 8. Must be < 9
+/* COMPRESS_STRATEGY can be 
+       Z_DEFAULT_STRATEGY (the default), 
+       Z_FILTERED (more huffmann, less string matching),
+       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
+#define        COMPRESS_MAX_LAZY                       258     
+#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
 
 static void usage(char *argv0)
 {
-       fprintf(stderr, "Usage:   %s <infile> <outfile>\n\n", argv0);
+       fprintf(stderr, "Usage:   %s <infile1> <infile2> ... <infile_n> <outfile>\n\n", argv0);
+       fprintf(stderr, "Combines n FPGA bitstream files and compresses them into one.\n\n");
 }
 
 
@@ -40,40 +57,78 @@ static void fpga_deflate_free(voidpf opaque, voidpf address)
 }
 
 
-int zlib_compress(FILE *infile, FILE *outfile)
+static bool all_feof(FILE *infile[], uint8_t num_infiles)
+{
+       for (uint16_t i = 0; i < num_infiles; i++) {
+               if (!feof(infile[i])) {
+                       return false;
+               }
+       }
+       
+       return true;
+}
+
+
+int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile)
 {
-       int i, ret;
+       uint8_t *fpga_config;
+       uint32_t i;
+       int ret;
+       uint8_t c;              
        z_stream compressed_fpga_stream;
+
+       fpga_config = malloc(num_infiles * FPGA_CONFIG_SIZE);
        
-       // read the input file into fpga_config[] and count occurrences of each symbol:
+       // read the input files interleaving into fpga_config[]
        i = 0;
-       while(!feof(infile)) {
-               uint8_t c;
-               c = fgetc(infile);
-               fpga_config[i++] = c;
-               if (i > FPGA_CONFIG_SIZE+1) {
-                       fprintf(stderr, "Input file too big (> %d bytes). This is probably not a PM3 FPGA config file.", FPGA_CONFIG_SIZE);
-                       fclose(infile);
-                       fclose(outfile);
+       do {
+               for(uint16_t j = 0; j < num_infiles; j++) {
+                       for(uint16_t k = 0; k < FPGA_INTERLEAVE_SIZE; k++) {
+                               c = fgetc(infile[j]);
+                               if (!feof(infile[j])) fpga_config[i++] = c; else fpga_config[i++] = '\0';
+                       }
+               }
+
+               if (i > num_infiles * FPGA_CONFIG_SIZE) {
+                       fprintf(stderr, "Input files too big (total of %ld > %d bytes). These are probably not PM3 FPGA config files.", i, num_infiles*FPGA_CONFIG_SIZE);
+                       for(uint16_t j = 0; j < num_infiles; j++) {
+                               fclose(infile[j]);
+                       }
                        return -1;
                }
-       }
+       } while (!all_feof(infile, num_infiles));
 
+       fprintf(stderr, "Read a total of %ld bytes from %d files\n", i, num_infiles);
+       
        // initialize zlib structures
        compressed_fpga_stream.next_in = fpga_config;
        compressed_fpga_stream.avail_in = i;
        compressed_fpga_stream.zalloc = fpga_deflate_malloc;
        compressed_fpga_stream.zfree = fpga_deflate_free;
        
+       ret = deflateInit2(&compressed_fpga_stream, 
+                                               COMPRESS_LEVEL,
+                                               Z_DEFLATED,
+                                               COMPRESS_WINDOW_BITS,
+                                               COMPRESS_MEM_LEVEL,
+                                               COMPRESS_STRATEGY);
+
        // estimate the size of the compressed output
        unsigned int outsize_max = deflateBound(&compressed_fpga_stream, compressed_fpga_stream.avail_in);
+       fprintf(stderr, "Allocating %ld bytes for output file (estimated upper bound)\n", outsize_max);
        uint8_t *outbuf = malloc(outsize_max);
        compressed_fpga_stream.next_out = outbuf;
        compressed_fpga_stream.avail_out = outsize_max;
-       fprintf(stderr, "Allocated %d bytes for output file (estimated upper bound)\n", outsize_max);
        
-       ret = deflateInit(&compressed_fpga_stream, COMPRESS_LEVEL);
-                               
+                                       
+       if (ret == Z_OK) {
+               ret = deflateTune(&compressed_fpga_stream,
+                                                       COMPRESS_GOOD_LENGTH,
+                                                       COMPRESS_MAX_LAZY,
+                                                       COMPRESS_MAX_NICE_LENGTH,
+                                                       COMPRESS_MAX_CHAIN);
+       }
+       
        if (ret == Z_OK) {
                ret = deflate(&compressed_fpga_stream, Z_FINISH);
        }
@@ -84,8 +139,12 @@ int zlib_compress(FILE *infile, FILE *outfile)
                fprintf(stderr, "Error in deflate(): %d %s\n", ret, compressed_fpga_stream.msg);
                free(outbuf);
                deflateEnd(&compressed_fpga_stream);
-               fclose(infile);
+               for(uint16_t j = 0; j < num_infiles; j++) {
+                       fclose(infile[j]);
+               }
                fclose(outfile);
+               free(infile);
+               free(fpga_config);
                return -1;
                }
                
@@ -95,9 +154,13 @@ int zlib_compress(FILE *infile, FILE *outfile)
 
        free(outbuf);
        deflateEnd(&compressed_fpga_stream);
-       fclose(infile);
+       for(uint16_t j = 0; j < num_infiles; j++) {
+               fclose(infile[j]);
+       }
        fclose(outfile);
-
+       free(infile);
+       free(fpga_config);
+       
        return 0;
        
 }
@@ -106,29 +169,29 @@ int zlib_compress(FILE *infile, FILE *outfile)
 
 int main(int argc, char **argv)
 {
-       char *infilename;
-       char *outfilename;
+       FILE **infiles;
+       FILE *outfile;
        
-       if (argc != 3) {
+       if (argc == 1 || argc == 2) {
                usage(argv[0]);
                return -1;
-       } else {
-               infilename = argv[1];
-               outfilename = argv[2];
-       }       
-
-       FILE *infile = fopen(infilename, "rb");
-       if (infile == NULL) {
-               fprintf(stderr, "Error. Cannot open input file %s", infilename);
-               return -1;
+       }
+       
+       infiles = calloc(argc-2, sizeof(FILE*));
+       
+       for (uint16_t i = 0; i < argc-2; i++) { 
+               infiles[i] = fopen(argv[i+1], "rb");
+               if (infiles[i] == NULL) {
+                       fprintf(stderr, "Error. Cannot open input file %s", argv[i+1]);
+                       return -1;
                }
-               
-       FILE *outfile = fopen(outfilename, "wb");
+       }
+
+       outfile = fopen(argv[argc-1], "wb");
        if (outfile == NULL) {
-               fprintf(stderr, "Error. Cannot open output file %s", outfilename);
-               fclose(infile);
+               fprintf(stderr, "Error. Cannot open output file %s", argv[argc-1]);
                return -1;
                }
                
-       return zlib_compress(infile, outfile);
+       return zlib_compress(infiles, argc-2, outfile);
 }
Impressum, Datenschutz