]> git.zerfleddert.de Git - proxmark3-svn/blame - client/fpga_compress.c
Typos
[proxmark3-svn] / client / fpga_compress.c
CommitLineData
e6153040 1//-----------------------------------------------------------------------------
2// This code is licensed to you under the terms of the GNU GPL, version 2 or,
3// at your option, any later version. See the LICENSE.txt file for the text of
4// the license.
5//-----------------------------------------------------------------------------
8e074056 6// Compression tool for FPGA config files. Compress several *.bit files at
7// compile time. Decompression is done at run time (see fpgaloader.c).
8// This uses the zlib library tuned to this specific case. The small file sizes
9// allow to use "insane" parameters for optimum compression ratio.
e6153040 10//-----------------------------------------------------------------------------
11
12#include <stdio.h>
13#include <stdlib.h>
14#include <string.h>
f3919878 15#include <stdint.h>
fb228974 16#include <stdbool.h>
f3919878 17#include "zlib.h"
e6153040 18
19#define MAX(a,b) ((a)>(b)?(a):(b))
20
f3919878 21// zlib configuration
22#define COMPRESS_LEVEL 9 // use best possible compression
8e074056 23#define COMPRESS_WINDOW_BITS 15 // default = max = 15 for a window of 2^15 = 32KBytes
24#define COMPRESS_MEM_LEVEL 9 // determines the amount of memory allocated during compression. Default = 8.
fb228974 25/* COMPRESS_STRATEGY can be
26 Z_DEFAULT_STRATEGY (the default),
27 Z_FILTERED (more huffmann, less string matching),
28 Z_HUFFMAN_ONLY (huffman only, no string matching)
29 Z_RLE (distances limited to one)
30 Z_FIXED (prevents the use of dynamic Huffman codes)
31*/
32#define COMPRESS_STRATEGY Z_DEFAULT_STRATEGY
33// zlib tuning parameters:
34#define COMPRESS_GOOD_LENGTH 258
35#define COMPRESS_MAX_LAZY 258
36#define COMPRESS_MAX_NICE_LENGTH 258
37#define COMPRESS_MAX_CHAIN 8192
38
39#define FPGA_INTERLEAVE_SIZE 288 // (the FPGA's internal config frame size is 288 bits. Interleaving with 288 bytes should give best compression)
40#define FPGA_CONFIG_SIZE 42336 // our current fpga_[lh]f.bit files are 42175 bytes. Rounded up to next multiple of FPGA_INTERLEAVE_SIZE
e6153040 41
8e074056 42static void usage(void)
e6153040 43{
8e074056 44 fprintf(stderr, "Usage: fpga_compress <infile1> <infile2> ... <infile_n> <outfile>\n");
45 fprintf(stderr, " Combine n FPGA bitstream files and compress them into one.\n\n");
46 fprintf(stderr, " fpga_compress -d <infile> <outfile>");
47 fprintf(stderr, " Decompress <infile>. Write result to <outfile>");
e6153040 48}
49
50
f3919878 51static voidpf fpga_deflate_malloc(voidpf opaque, uInt items, uInt size)
e6153040 52{
f3919878 53 return malloc(items*size);
e6153040 54}
e6153040 55
f3919878 56
57static void fpga_deflate_free(voidpf opaque, voidpf address)
e6153040 58{
f3919878 59 return free(address);
60}
e6153040 61
f3919878 62
fb228974 63static bool all_feof(FILE *infile[], uint8_t num_infiles)
64{
65 for (uint16_t i = 0; i < num_infiles; i++) {
66 if (!feof(infile[i])) {
67 return false;
68 }
69 }
70
71 return true;
72}
73
74
75int zlib_compress(FILE *infile[], uint8_t num_infiles, FILE *outfile)
e6153040 76{
fb228974 77 uint8_t *fpga_config;
78 uint32_t i;
79 int ret;
80 uint8_t c;
f3919878 81 z_stream compressed_fpga_stream;
fb228974 82
83 fpga_config = malloc(num_infiles * FPGA_CONFIG_SIZE);
e6153040 84
8e074056 85 // read the input files. Interleave them into fpga_config[]
e6153040 86 i = 0;
fb228974 87 do {
7b242c1c 88
89 if (i >= num_infiles * FPGA_CONFIG_SIZE) {
90 fprintf(stderr, "Input files too big (total > %lu bytes). These are probably not PM3 FPGA config files.\n", num_infiles*FPGA_CONFIG_SIZE);
91 for(uint16_t j = 0; j < num_infiles; j++) {
92 fclose(infile[j]);
93 }
38d618ba 94 free(fpga_config);
7b242c1c 95 return(EXIT_FAILURE);
96 }
97
fb228974 98 for(uint16_t j = 0; j < num_infiles; j++) {
99 for(uint16_t k = 0; k < FPGA_INTERLEAVE_SIZE; k++) {
100 c = fgetc(infile[j]);
0fa01ec7 101 if (!feof(infile[j])) {
102 fpga_config[i++] = c;
103 } else if (num_infiles > 1) {
104 fpga_config[i++] = '\0';
105 }
fb228974 106 }
107 }
108
fb228974 109 } while (!all_feof(infile, num_infiles));
e6153040 110
f3919878 111 // initialize zlib structures
112 compressed_fpga_stream.next_in = fpga_config;
113 compressed_fpga_stream.avail_in = i;
114 compressed_fpga_stream.zalloc = fpga_deflate_malloc;
115 compressed_fpga_stream.zfree = fpga_deflate_free;
38d618ba 116 compressed_fpga_stream.opaque = Z_NULL;
fb228974 117 ret = deflateInit2(&compressed_fpga_stream,
118 COMPRESS_LEVEL,
119 Z_DEFLATED,
120 COMPRESS_WINDOW_BITS,
121 COMPRESS_MEM_LEVEL,
122 COMPRESS_STRATEGY);
123
f3919878 124 // estimate the size of the compressed output
125 unsigned int outsize_max = deflateBound(&compressed_fpga_stream, compressed_fpga_stream.avail_in);
126 uint8_t *outbuf = malloc(outsize_max);
127 compressed_fpga_stream.next_out = outbuf;
128 compressed_fpga_stream.avail_out = outsize_max;
fb228974 129
130 if (ret == Z_OK) {
131 ret = deflateTune(&compressed_fpga_stream,
132 COMPRESS_GOOD_LENGTH,
133 COMPRESS_MAX_LAZY,
134 COMPRESS_MAX_NICE_LENGTH,
135 COMPRESS_MAX_CHAIN);
136 }
137
f3919878 138 if (ret == Z_OK) {
139 ret = deflate(&compressed_fpga_stream, Z_FINISH);
e6153040 140 }
e6153040 141
97a0f5f4 142 fprintf(stderr, "compressed %lu input bytes to %lu output bytes\n", i, compressed_fpga_stream.total_out);
f3919878 143
144 if (ret != Z_STREAM_END) {
145 fprintf(stderr, "Error in deflate(): %d %s\n", ret, compressed_fpga_stream.msg);
146 free(outbuf);
147 deflateEnd(&compressed_fpga_stream);
fb228974 148 for(uint16_t j = 0; j < num_infiles; j++) {
149 fclose(infile[j]);
150 }
f3919878 151 fclose(outfile);
fb228974 152 free(infile);
153 free(fpga_config);
7b242c1c 154 return(EXIT_FAILURE);
f3919878 155 }
e6153040 156
f3919878 157 for (i = 0; i < compressed_fpga_stream.total_out; i++) {
158 fputc(outbuf[i], outfile);
159 }
160
161 free(outbuf);
162 deflateEnd(&compressed_fpga_stream);
fb228974 163 for(uint16_t j = 0; j < num_infiles; j++) {
164 fclose(infile[j]);
165 }
e6153040 166 fclose(outfile);
fb228974 167 free(infile);
168 free(fpga_config);
169
7b242c1c 170 return(EXIT_SUCCESS);
f3919878 171
e6153040 172}
173
174
4b3f6d79 175int zlib_decompress(FILE *infile, FILE *outfile)
176{
177 #define DECOMPRESS_BUF_SIZE 1024
178 uint8_t outbuf[DECOMPRESS_BUF_SIZE];
179 uint8_t inbuf[DECOMPRESS_BUF_SIZE];
180 int ret;
181
182 z_stream compressed_fpga_stream;
8e074056 183
4b3f6d79 184 // initialize zlib structures
185 compressed_fpga_stream.next_in = inbuf;
186 compressed_fpga_stream.avail_in = 0;
187 compressed_fpga_stream.next_out = outbuf;
188 compressed_fpga_stream.avail_out = DECOMPRESS_BUF_SIZE;
189 compressed_fpga_stream.zalloc = fpga_deflate_malloc;
190 compressed_fpga_stream.zfree = fpga_deflate_free;
38d618ba 191 compressed_fpga_stream.opaque = Z_NULL;
4b3f6d79 192
193 ret = inflateInit2(&compressed_fpga_stream, 0);
194
195 do {
196 if (compressed_fpga_stream.avail_in == 0) {
197 compressed_fpga_stream.next_in = inbuf;
198 uint16_t i = 0;
199 do {
38d618ba 200 int c = fgetc(infile);
4b3f6d79 201 if (!feof(infile)) {
38d618ba 202 inbuf[i++] = c & 0xFF;
4b3f6d79 203 compressed_fpga_stream.avail_in++;
204 } else {
205 break;
206 }
207 } while (i < DECOMPRESS_BUF_SIZE);
208 }
209
210 ret = inflate(&compressed_fpga_stream, Z_SYNC_FLUSH);
211
212 if (ret != Z_OK && ret != Z_STREAM_END) {
213 break;
214 }
215
216 if (compressed_fpga_stream.avail_out == 0) {
217 for (uint16_t i = 0; i < DECOMPRESS_BUF_SIZE; i++) {
218 fputc(outbuf[i], outfile);
219 }
220 compressed_fpga_stream.avail_out = DECOMPRESS_BUF_SIZE;
221 compressed_fpga_stream.next_out = outbuf;
222 }
223 } while (ret == Z_OK);
224
225 if (ret == Z_STREAM_END) { // reached end of input
226 uint16_t i = 0;
227 while (compressed_fpga_stream.avail_out < DECOMPRESS_BUF_SIZE) {
228 fputc(outbuf[i++], outfile);
229 compressed_fpga_stream.avail_out++;
230 }
231 fclose(outfile);
232 fclose(infile);
7b242c1c 233 return(EXIT_SUCCESS);
4b3f6d79 234 } else {
235 fprintf(stderr, "Error. Inflate() returned error %d, %s", ret, compressed_fpga_stream.msg);
236 fclose(outfile);
237 fclose(infile);
7b242c1c 238 return(EXIT_FAILURE);
4b3f6d79 239 }
240
241}
242
f3919878 243
e6153040 244int main(int argc, char **argv)
245{
fb228974 246 FILE **infiles;
247 FILE *outfile;
e6153040 248
fb228974 249 if (argc == 1 || argc == 2) {
8e074056 250 usage();
7b242c1c 251 return(EXIT_FAILURE);
fb228974 252 }
253
8e074056 254 if (!strcmp(argv[1], "-d")) { // Decompress
4b3f6d79 255 infiles = calloc(1, sizeof(FILE*));
256 if (argc != 4) {
8e074056 257 usage();
7b242c1c 258 return(EXIT_FAILURE);
4b3f6d79 259 }
260 infiles[0] = fopen(argv[2], "rb");
261 if (infiles[0] == NULL) {
262 fprintf(stderr, "Error. Cannot open input file %s", argv[2]);
7b242c1c 263 return(EXIT_FAILURE);
4b3f6d79 264 }
265 outfile = fopen(argv[3], "wb");
266 if (outfile == NULL) {
267 fprintf(stderr, "Error. Cannot open output file %s", argv[3]);
7b242c1c 268 return(EXIT_FAILURE);
4b3f6d79 269 }
270 return zlib_decompress(infiles[0], outfile);
4b3f6d79 271
8e074056 272 } else { // Compress
273
274 infiles = calloc(argc-2, sizeof(FILE*));
275 for (uint16_t i = 0; i < argc-2; i++) {
276 infiles[i] = fopen(argv[i+1], "rb");
277 if (infiles[i] == NULL) {
278 fprintf(stderr, "Error. Cannot open input file %s", argv[i+1]);
7b242c1c 279 return(EXIT_FAILURE);
8e074056 280 }
281 }
282 outfile = fopen(argv[argc-1], "wb");
283 if (outfile == NULL) {
284 fprintf(stderr, "Error. Cannot open output file %s", argv[argc-1]);
7b242c1c 285 return(EXIT_FAILURE);
e6153040 286 }
8e074056 287 return zlib_compress(infiles, argc-2, outfile);
fb228974 288 }
e6153040 289}
Impressum, Datenschutz