refactor lfops t55xx functions

[proxmark3-svn] / client / fpga_compress.c

diff --git a/client/fpga_compress.c b/client/fpga_compress.c
index db1ef81b6a0fd27cd7ca04d6fb29e5d10c8a2138..2779e8350ec90870ed8a6d779b43cda09ce2aa79 100644 (file)
--- a/client/fpga_compress.c
+++ b/client/fpga_compress.c
@@ -3,61 +3,109 @@
 // at your option, any later version. See the LICENSE.txt file for the text of
 // the license.
 //-----------------------------------------------------------------------------
 // at your option, any later version. See the LICENSE.txt file for the text of
 // the license.
 //-----------------------------------------------------------------------------

-// Flasher frontend tool
+// Compression tool for FPGA config files. Compress several *.bit files at
+// compile time. Decompression is done at run time (see fpgaloader.c).
+// This uses the zlib library tuned to this specific case. The small file sizes
+// allow to use "insane" parameters for optimum compression ratio.

 //-----------------------------------------------------------------------------
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <stdint.h>
 //-----------------------------------------------------------------------------
 
 #include <stdio.h>
 #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
 #include "zlib.h"
 
 #define MAX(a,b) ((a)>(b)?(a):(b))
 
 // zlib configuration
 #define COMPRESS_LEVEL                 9               // use best possible compression

+#define COMPRESS_WINDOW_BITS   15              // default = max = 15 for a window of 2^15 = 32KBytes
+#define COMPRESS_MEM_LEVEL             9               // determines the amount of memory allocated during compression. Default = 8.
+/* 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_CONFIG_SIZE       42175
-static uint8_t fpga_config[FPGA_CONFIG_SIZE];
+#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)
+static void usage(void)

 {
 {

-       fprintf(stderr, "Usage:   %s <infile> <outfile>\n\n", argv0);
+       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>");

 }
 
 
 static voidpf fpga_deflate_malloc(voidpf opaque, uInt items, uInt size)
 {
 }
 
 
 static voidpf fpga_deflate_malloc(voidpf opaque, uInt items, uInt size)
 {

-       fprintf(stderr, "zlib requested %d bytes\n", items*size);

        return malloc(items*size);
 }
 
 
 static void fpga_deflate_free(voidpf opaque, voidpf address)
 {
        return malloc(items*size);
 }
 
 
 static void fpga_deflate_free(voidpf opaque, voidpf address)
 {

-       fprintf(stderr, "zlib frees memory\n");

        return free(address);
 }
 
 
        return free(address);
 }
 
 

-int zlib_compress(FILE *infile, FILE *outfile)
+static bool all_feof(FILE *infile[], uint8_t num_infiles)

 {
 {

-       int i, ret;
+       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)
+{
+       uint8_t *fpga_config;
+       uint32_t i;
+       int ret;
+       uint8_t c;              

        z_stream compressed_fpga_stream;
        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. Interleave them into fpga_config[]

        i = 0;
        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);
-                       return -1;
+       do {
+
+               if (i >= num_infiles * FPGA_CONFIG_SIZE) {
+                       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]);
+                       }
+                       return(EXIT_FAILURE);
+               }
+
+               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 if (num_infiles > 1) {
+                                       fpga_config[i++] = '\0';
+                               }
+                       }

                }
                }

-       }
+
+       } while (!all_feof(infile, num_infiles));

 
        // initialize zlib structures
        compressed_fpga_stream.next_in = fpga_config;
 
        // initialize zlib structures
        compressed_fpga_stream.next_in = fpga_config;


@@ -65,28 +113,44 @@ int zlib_compress(FILE *infile, FILE *outfile)
        compressed_fpga_stream.zalloc = fpga_deflate_malloc;
        compressed_fpga_stream.zfree = fpga_deflate_free;
        
        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);
        uint8_t *outbuf = malloc(outsize_max);
        compressed_fpga_stream.next_out = outbuf;
        compressed_fpga_stream.avail_out = outsize_max;
        // estimate the size of the compressed output
        unsigned int 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;

-       fprintf(stderr, "Allocated %d bytes for output file (estimated upper bound)\n", outsize_max);
+                                       
+       if (ret == Z_OK) {
+               ret = deflateTune(&compressed_fpga_stream,
+                                                       COMPRESS_GOOD_LENGTH,
+                                                       COMPRESS_MAX_LAZY,
+                                                       COMPRESS_MAX_NICE_LENGTH,
+                                                       COMPRESS_MAX_CHAIN);
+       }

        
        

-       ret = deflateInit(&compressed_fpga_stream, COMPRESS_LEVEL);
-                               

        if (ret == Z_OK) {
                ret = deflate(&compressed_fpga_stream, Z_FINISH);
        }
        
        if (ret == Z_OK) {
                ret = deflate(&compressed_fpga_stream, Z_FINISH);
        }
        

-       fprintf(stderr, "produced %d bytes of output\n", compressed_fpga_stream.total_out);
+       fprintf(stderr, "compressed %lu 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);
                free(outbuf);
                deflateEnd(&compressed_fpga_stream);
 
        if (ret != Z_STREAM_END) {
                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);
                fclose(outfile);

-               return -1;
+               free(infile);
+               free(fpga_config);
+               return(EXIT_FAILURE);

                }
                
        for (i = 0; i < compressed_fpga_stream.total_out; i++) {
                }
                
        for (i = 0; i < compressed_fpga_stream.total_out; i++) {


@@ -95,40 +159,129 @@ int zlib_compress(FILE *infile, FILE *outfile)
 
        free(outbuf);
        deflateEnd(&compressed_fpga_stream);
 
        free(outbuf);
        deflateEnd(&compressed_fpga_stream);

-       fclose(infile);
+       for(uint16_t j = 0; j < num_infiles; j++) {
+               fclose(infile[j]);
+       }

        fclose(outfile);
        fclose(outfile);

-
-       return 0;
+       free(infile);
+       free(fpga_config);
+       
+       return(EXIT_SUCCESS);

        
 }
 
 
        
 }
 
 

+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;
+       
+       z_stream compressed_fpga_stream;
+
+       // initialize zlib structures
+       compressed_fpga_stream.next_in = inbuf;
+       compressed_fpga_stream.avail_in = 0;
+       compressed_fpga_stream.next_out = outbuf;
+       compressed_fpga_stream.avail_out = DECOMPRESS_BUF_SIZE;
+       compressed_fpga_stream.zalloc = fpga_deflate_malloc;
+       compressed_fpga_stream.zfree = fpga_deflate_free;
+       
+       ret = inflateInit2(&compressed_fpga_stream, 0);
+       
+       do {
+               if (compressed_fpga_stream.avail_in == 0) {
+                       compressed_fpga_stream.next_in = inbuf;
+                       uint16_t i = 0;
+                       do {
+                               uint8_t c = fgetc(infile);
+                               if (!feof(infile)) {
+                                       inbuf[i++] = c;
+                                       compressed_fpga_stream.avail_in++;
+                               } else {
+                                       break;
+                               }
+                       } while (i < DECOMPRESS_BUF_SIZE);
+               }
+
+               ret = inflate(&compressed_fpga_stream, Z_SYNC_FLUSH);
+
+               if (ret != Z_OK && ret != Z_STREAM_END) {
+                       break;
+               }
+
+               if (compressed_fpga_stream.avail_out == 0) {
+                       for (uint16_t i = 0; i < DECOMPRESS_BUF_SIZE; i++) {
+                               fputc(outbuf[i], outfile);
+                       }
+                       compressed_fpga_stream.avail_out = DECOMPRESS_BUF_SIZE;
+                       compressed_fpga_stream.next_out = outbuf;
+               }
+       } while (ret == Z_OK);
+
+       if (ret == Z_STREAM_END) {  // reached end of input
+               uint16_t i = 0;
+               while (compressed_fpga_stream.avail_out < DECOMPRESS_BUF_SIZE) {
+                       fputc(outbuf[i++], outfile);
+                       compressed_fpga_stream.avail_out++;
+               }
+               fclose(outfile);
+               fclose(infile);
+               return(EXIT_SUCCESS);
+       } else {
+               fprintf(stderr, "Error. Inflate() returned error %d, %s", ret, compressed_fpga_stream.msg);
+               fclose(outfile);
+               fclose(infile);
+               return(EXIT_FAILURE);
+       }
+       
+}
+

 
 int main(int argc, char **argv)
 {
 
 int main(int argc, char **argv)
 {

-       char *infilename;
-       char *outfilename;
+       FILE **infiles;
+       FILE *outfile;

        
        

-       if (argc != 3) {
-               usage(argv[0]);
-               return -1;
-       } else {
-               infilename = argv[1];
-               outfilename = argv[2];
-       }       
+       if (argc == 1 || argc == 2) {
+               usage();
+               return(EXIT_FAILURE);
+       }
+       
+       if (!strcmp(argv[1], "-d")) {                   // Decompress
+               infiles = calloc(1, sizeof(FILE*));
+               if (argc != 4) {
+                       usage();
+                       return(EXIT_FAILURE);
+               } 
+               infiles[0] = fopen(argv[2], "rb");
+               if (infiles[0] == NULL) {
+                       fprintf(stderr, "Error. Cannot open input file %s", argv[2]);
+                       return(EXIT_FAILURE);
+               }
+               outfile = fopen(argv[3], "wb");
+               if (outfile == NULL) {
+                       fprintf(stderr, "Error. Cannot open output file %s", argv[3]);
+                       return(EXIT_FAILURE);
+               }
+               return zlib_decompress(infiles[0], outfile);

 
 

-       FILE *infile = fopen(infilename, "rb");
-       if (infile == NULL) {
-               fprintf(stderr, "Error. Cannot open input file %s", infilename);
-               return -1;
+       } else {                                                                // Compress
+
+               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(EXIT_FAILURE);
+                       }

                }
                }

-               
-       FILE *outfile = fopen(outfilename, "wb");
-       if (outfile == NULL) {
-               fprintf(stderr, "Error. Cannot open output file %s", outfilename);
-               fclose(infile);
-               return -1;
+               outfile = fopen(argv[argc-1], "wb");
+               if (outfile == NULL) {
+                       fprintf(stderr, "Error. Cannot open output file %s", argv[argc-1]);
+                       return(EXIT_FAILURE);

                }
                }

-               
-       return zlib_compress(infile, outfile);
+               return zlib_compress(infiles, argc-2, outfile);
+       }

 }
 }