hf topaz reader implementation:

[proxmark3-svn] / armsrc / fpgaloader.c

diff --git a/armsrc/fpgaloader.c b/armsrc/fpgaloader.c
index 573aac3a8af9f8f288279a401a79aa443214e47a..308dda8c09e6ebf8fd0a691df91ccb0c0c3189d2 100644 (file)
--- a/armsrc/fpgaloader.c
+++ b/armsrc/fpgaloader.c
@@ -26,13 +26,15 @@ extern void Dbprintf(const char *fmt, ...);
 static int downloaded_bitstream = FPGA_BITSTREAM_ERR;
 
 // this is where the bitstreams are located in memory:
 static int downloaded_bitstream = FPGA_BITSTREAM_ERR;
 
 // this is where the bitstreams are located in memory:

-extern uint8_t _binary_fpga_lf_bit_start, _binary_fpga_lf_bit_end;
-extern uint8_t _binary_fpga_hf_bit_start, _binary_fpga_hf_bit_end;
+extern uint8_t _binary_obj_fpga_all_bit_z_start, _binary_obj_fpga_all_bit_z_end;
+

 static uint8_t *fpga_image_ptr = NULL;
 static uint8_t *fpga_image_ptr = NULL;

+static uint32_t uncompressed_bytes_cnt;

 
 static const uint8_t _bitparse_fixed_header[] = {0x00, 0x09, 0x0f, 0xf0, 0x0f, 0xf0, 0x0f, 0xf0, 0x0f, 0xf0, 0x00, 0x00, 0x01};
 #define FPGA_BITSTREAM_FIXED_HEADER_SIZE       sizeof(_bitparse_fixed_header)
 
 static const uint8_t _bitparse_fixed_header[] = {0x00, 0x09, 0x0f, 0xf0, 0x0f, 0xf0, 0x0f, 0xf0, 0x0f, 0xf0, 0x00, 0x00, 0x01};
 #define FPGA_BITSTREAM_FIXED_HEADER_SIZE       sizeof(_bitparse_fixed_header)

-#define OUTPUT_BUFFER_LEN 80
+#define OUTPUT_BUFFER_LEN              80
+#define FPGA_INTERLEAVE_SIZE   288

 
 //-----------------------------------------------------------------------------
 // Set up the Serial Peripheral Interface as master
 
 //-----------------------------------------------------------------------------
 // Set up the Serial Peripheral Interface as master


@@ -171,7 +173,11 @@ bool FpgaSetupSscDma(uint8_t *buf, int len)
 }
 
 
 }
 
 

-static int get_from_fpga_stream(z_streamp compressed_fpga_stream, uint8_t *output_buffer)
+//----------------------------------------------------------------------------
+// Uncompress (inflate) the FPGA data. Returns one decompressed byte with
+// each call. 
+//----------------------------------------------------------------------------
+static int get_from_fpga_combined_stream(z_streamp compressed_fpga_stream, uint8_t *output_buffer)

 {
        if (fpga_image_ptr == compressed_fpga_stream->next_out) {       // need more data
                compressed_fpga_stream->next_out = output_buffer;
 {
        if (fpga_image_ptr == compressed_fpga_stream->next_out) {       // need more data
                compressed_fpga_stream->next_out = output_buffer;


@@ -186,54 +192,63 @@ static int get_from_fpga_stream(z_streamp compressed_fpga_stream, uint8_t *outpu
                }
        }
 
                }
        }
 

+       uncompressed_bytes_cnt++;
+       

        return *fpga_image_ptr++;
 }
 
        return *fpga_image_ptr++;
 }
 

+//----------------------------------------------------------------------------
+// Undo the interleaving of several FPGA config files. FPGA config files
+// are combined into one big file:
+// 288 bytes from FPGA file 1, followed by 288 bytes from FGPA file 2, etc.
+//----------------------------------------------------------------------------
+static int get_from_fpga_stream(int bitstream_version, z_streamp compressed_fpga_stream, uint8_t *output_buffer)
+{
+       while((uncompressed_bytes_cnt / FPGA_INTERLEAVE_SIZE) % FPGA_BITSTREAM_MAX != (bitstream_version - 1)) {
+               // skip undesired data belonging to other bitstream_versions
+               get_from_fpga_combined_stream(compressed_fpga_stream, output_buffer);
+       }
+
+       return get_from_fpga_combined_stream(compressed_fpga_stream, output_buffer);
+       
+}
+

 
 static voidpf fpga_inflate_malloc(voidpf opaque, uInt items, uInt size)
 {
 
 static voidpf fpga_inflate_malloc(voidpf opaque, uInt items, uInt size)
 {

-       Dbprintf("zlib requested %d bytes", items*size);

        return BigBuf_malloc(items*size);
 }
 
 
 static void fpga_inflate_free(voidpf opaque, voidpf address)
 {
        return BigBuf_malloc(items*size);
 }
 
 
 static void fpga_inflate_free(voidpf opaque, voidpf address)
 {

-       Dbprintf("zlib frees memory");
-       BigBuf_free_keep_EM();
+       BigBuf_free();

 }
 
 
 }
 
 

+//----------------------------------------------------------------------------
+// Initialize decompression of the respective (HF or LF) FPGA stream 
+//----------------------------------------------------------------------------

 static bool reset_fpga_stream(int bitstream_version, z_streamp compressed_fpga_stream, uint8_t *output_buffer)
 {
        uint8_t header[FPGA_BITSTREAM_FIXED_HEADER_SIZE];
 static bool reset_fpga_stream(int bitstream_version, z_streamp compressed_fpga_stream, uint8_t *output_buffer)
 {
        uint8_t header[FPGA_BITSTREAM_FIXED_HEADER_SIZE];

-       uint8_t *fpga_image_start;
-       uint32_t fpga_image_size;

        
        

-       if (bitstream_version == FPGA_BITSTREAM_LF) {
-               fpga_image_start = &_binary_fpga_lf_bit_start;
-               fpga_image_size = (uint32_t)&_binary_fpga_lf_bit_end - (uint32_t)&_binary_fpga_lf_bit_start;
-       } else if (bitstream_version == FPGA_BITSTREAM_HF) {
-               fpga_image_start = &_binary_fpga_hf_bit_start;
-               fpga_image_size = (uint32_t)&_binary_fpga_hf_bit_end - (uint32_t)&_binary_fpga_hf_bit_start;
-       } else {
-               return false;
-       }       
-
+       uncompressed_bytes_cnt = 0;
+       

        // initialize z_stream structure for inflate:
        // initialize z_stream structure for inflate:

-       compressed_fpga_stream->next_in = fpga_image_start;
-       compressed_fpga_stream->avail_in = fpga_image_size;
+       compressed_fpga_stream->next_in = &_binary_obj_fpga_all_bit_z_start;
+       compressed_fpga_stream->avail_in = &_binary_obj_fpga_all_bit_z_start - &_binary_obj_fpga_all_bit_z_end;

        compressed_fpga_stream->next_out = output_buffer;
        compressed_fpga_stream->avail_out = OUTPUT_BUFFER_LEN;
        compressed_fpga_stream->zalloc = &fpga_inflate_malloc;
        compressed_fpga_stream->zfree = &fpga_inflate_free;
 
        compressed_fpga_stream->next_out = output_buffer;
        compressed_fpga_stream->avail_out = OUTPUT_BUFFER_LEN;
        compressed_fpga_stream->zalloc = &fpga_inflate_malloc;
        compressed_fpga_stream->zfree = &fpga_inflate_free;
 

-       inflateInit2(compressed_fpga_stream, 15);
+       inflateInit2(compressed_fpga_stream, 0);

 
        fpga_image_ptr = output_buffer;
 
        for (uint16_t i = 0; i < FPGA_BITSTREAM_FIXED_HEADER_SIZE; i++) {
 
        fpga_image_ptr = output_buffer;
 
        for (uint16_t i = 0; i < FPGA_BITSTREAM_FIXED_HEADER_SIZE; i++) {

-               header[i] = get_from_fpga_stream(compressed_fpga_stream, output_buffer);
+               header[i] = get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer);

        }
        
        // Check for a valid .bit file (starts with _bitparse_fixed_header)
        }
        
        // Check for a valid .bit file (starts with _bitparse_fixed_header)


@@ -259,7 +274,7 @@ static void DownloadFPGA_byte(unsigned char w)
 }
 
 // Download the fpga image starting at current stream position with length FpgaImageLen bytes
 }
 
 // Download the fpga image starting at current stream position with length FpgaImageLen bytes

-static void DownloadFPGA(int FpgaImageLen, z_streamp compressed_fpga_stream, uint8_t *output_buffer)
+static void DownloadFPGA(int bitstream_version, int FpgaImageLen, z_streamp compressed_fpga_stream, uint8_t *output_buffer)

 {
 
        Dbprintf("DownloadFPGA(len: %d)", FpgaImageLen);
 {
 
        Dbprintf("DownloadFPGA(len: %d)", FpgaImageLen);


@@ -316,7 +331,7 @@ static void DownloadFPGA(int FpgaImageLen, z_streamp compressed_fpga_stream, uin
        }
 
        for(i = 0; i < FpgaImageLen; i++) {
        }
 
        for(i = 0; i < FpgaImageLen; i++) {

-               int b = get_from_fpga_stream(compressed_fpga_stream, output_buffer);
+               int b = get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer);

                if (b < 0) {
                        Dbprintf("Error %d during FpgaDownload", b);
                        break;
                if (b < 0) {
                        Dbprintf("Error %d during FpgaDownload", b);
                        break;


@@ -324,8 +339,6 @@ static void DownloadFPGA(int FpgaImageLen, z_streamp compressed_fpga_stream, uin
                DownloadFPGA_byte(b);
        }
        
                DownloadFPGA_byte(b);
        }
        

-       Dbprintf("%d bytes loaded into FPGA", i);
-       

        // continue to clock FPGA until ready signal goes high
        i=100000;
        while ( (i--) && ( !(AT91C_BASE_PIOA->PIO_PDSR & GPIO_FPGA_DONE ) ) ) {
        // continue to clock FPGA until ready signal goes high
        i=100000;
        while ( (i--) && ( !(AT91C_BASE_PIOA->PIO_PDSR & GPIO_FPGA_DONE ) ) ) {


@@ -348,13 +361,13 @@ static void DownloadFPGA(int FpgaImageLen, z_streamp compressed_fpga_stream, uin
  * (big endian), <length> bytes content. Except for section 'e' which has 4 bytes
  * length.
  */
  * (big endian), <length> bytes content. Except for section 'e' which has 4 bytes
  * length.
  */

-static int bitparse_find_section(char section_name, unsigned int *section_length, z_streamp compressed_fpga_stream, uint8_t *output_buffer)
+static int bitparse_find_section(int bitstream_version, char section_name, unsigned int *section_length, z_streamp compressed_fpga_stream, uint8_t *output_buffer)

 {
        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) {
 {
        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 = get_from_fpga_stream(compressed_fpga_stream, output_buffer);
+               char current_name = get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer);

                numbytes++;
                unsigned int current_length = 0;
                if(current_name < 'a' || current_name > 'e') {
                numbytes++;
                unsigned int current_length = 0;
                if(current_name < 'a' || current_name > 'e') {


@@ -365,12 +378,12 @@ static int bitparse_find_section(char section_name, unsigned int *section_length
                switch(current_name) {
                case 'e':
                        /* Four byte length field */
                switch(current_name) {
                case 'e':
                        /* Four byte length field */

-                       current_length += get_from_fpga_stream(compressed_fpga_stream, output_buffer) << 24;
-                       current_length += get_from_fpga_stream(compressed_fpga_stream, output_buffer) << 16;
+                       current_length += get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer) << 24;
+                       current_length += get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer) << 16;

                        numbytes += 2;
                default: /* Fall through, two byte length field */
                        numbytes += 2;
                default: /* Fall through, two byte length field */

-                       current_length += get_from_fpga_stream(compressed_fpga_stream, output_buffer) << 8;
-                       current_length += get_from_fpga_stream(compressed_fpga_stream, output_buffer) << 0;
+                       current_length += get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer) << 8;
+                       current_length += get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer) << 0;

                        numbytes += 2;
                }
 
                        numbytes += 2;
                }
 


@@ -387,7 +400,7 @@ static int bitparse_find_section(char section_name, unsigned int *section_length
                }
 
                for (uint16_t i = 0; i < current_length && numbytes < MAX_FPGA_BIT_STREAM_HEADER_SEARCH; i++) {
                }
 
                for (uint16_t i = 0; i < current_length && numbytes < MAX_FPGA_BIT_STREAM_HEADER_SEARCH; i++) {

-                       get_from_fpga_stream(compressed_fpga_stream, output_buffer);
+                       get_from_fpga_stream(bitstream_version, compressed_fpga_stream, output_buffer);

                        numbytes++;
                }
        }
                        numbytes++;
                }
        }


@@ -396,10 +409,10 @@ static int bitparse_find_section(char section_name, unsigned int *section_length
 }
 
 
 }
 
 

-//-----------------------------------------------------------------------------
-// Find out which FPGA image format is stored in flash, then call DownloadFPGA
-// with the right parameters to download the image
-//-----------------------------------------------------------------------------
+//----------------------------------------------------------------------------
+// Check which FPGA image is currently loaded (if any). If necessary 
+// decompress and load the correct (HF or LF) image to the FPGA
+//----------------------------------------------------------------------------

 void FpgaDownloadAndGo(int bitstream_version)
 {
        z_stream compressed_fpga_stream;
 void FpgaDownloadAndGo(int bitstream_version)
 {
        z_stream compressed_fpga_stream;


@@ -409,21 +422,29 @@ void FpgaDownloadAndGo(int bitstream_version)
        if (downloaded_bitstream == bitstream_version)
                return;
 
        if (downloaded_bitstream == bitstream_version)
                return;
 

+       // make sure that we have enough memory to decompress
+       BigBuf_free();
+       

        if (!reset_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer)) {
                return;
        }
 
        unsigned int bitstream_length;
        if (!reset_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer)) {
                return;
        }
 
        unsigned int bitstream_length;

-       if(bitparse_find_section('e', &bitstream_length, &compressed_fpga_stream, output_buffer)) {
-               DownloadFPGA(bitstream_length, &compressed_fpga_stream, output_buffer);
+       if(bitparse_find_section(bitstream_version, 'e', &bitstream_length, &compressed_fpga_stream, output_buffer)) {
+               DownloadFPGA(bitstream_version, bitstream_length, &compressed_fpga_stream, output_buffer);

                downloaded_bitstream = bitstream_version;
        }
 
        inflateEnd(&compressed_fpga_stream);
                downloaded_bitstream = bitstream_version;
        }
 
        inflateEnd(&compressed_fpga_stream);

-               

 }      
 
 
 }      
 
 

+//-----------------------------------------------------------------------------
+// Gather version information from FPGA image. Needs to decompress the begin 
+// of the respective (HF or LF) image.
+// Note: decompression makes use of (i.e. overwrites) BigBuf[]. It is therefore
+// advisable to call this only once and store the results for later use.
+//-----------------------------------------------------------------------------

 void FpgaGatherVersion(int bitstream_version, char *dst, int len)
 {
        unsigned int fpga_info_len;
 void FpgaGatherVersion(int bitstream_version, char *dst, int len)
 {
        unsigned int fpga_info_len;


@@ -433,13 +454,16 @@ void FpgaGatherVersion(int bitstream_version, char *dst, int len)
        
        dst[0] = '\0';
 
        
        dst[0] = '\0';
 

+       // ensure that we can allocate enough memory for decompression:
+       BigBuf_free();
+

        if (!reset_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer)) {
                return;
        }
 
        if (!reset_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer)) {
                return;
        }
 

-       if(bitparse_find_section('a', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {
+       if(bitparse_find_section(bitstream_version, 'a', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {

                for (uint16_t i = 0; i < fpga_info_len; i++) {
                for (uint16_t i = 0; i < fpga_info_len; i++) {

-                       char c = (char)get_from_fpga_stream(&compressed_fpga_stream, output_buffer);
+                       char c = (char)get_from_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer);

                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }
                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }


@@ -450,30 +474,30 @@ void FpgaGatherVersion(int bitstream_version, char *dst, int len)
                        strncat(dst, "HF ", len-1);
        }
        strncat(dst, "FPGA image built", len-1);
                        strncat(dst, "HF ", len-1);
        }
        strncat(dst, "FPGA image built", len-1);

-       if(bitparse_find_section('b', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {
+       if(bitparse_find_section(bitstream_version, 'b', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {

                strncat(dst, " for ", len-1);
                for (uint16_t i = 0; i < fpga_info_len; i++) {
                strncat(dst, " for ", len-1);
                for (uint16_t i = 0; i < fpga_info_len; i++) {

-                       char c = (char)get_from_fpga_stream(&compressed_fpga_stream, output_buffer);
+                       char c = (char)get_from_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer);

                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }
                }
                strncat(dst, tempstr, len-1);
        }
                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }
                }
                strncat(dst, tempstr, len-1);
        }

-       if(bitparse_find_section('c', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {
+       if(bitparse_find_section(bitstream_version, 'c', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {

                strncat(dst, " on ", len-1);
                for (uint16_t i = 0; i < fpga_info_len; i++) {
                strncat(dst, " on ", len-1);
                for (uint16_t i = 0; i < fpga_info_len; i++) {

-                       char c = (char)get_from_fpga_stream(&compressed_fpga_stream, output_buffer);
+                       char c = (char)get_from_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer);

                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }
                }
                strncat(dst, tempstr, len-1);
        }
                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }
                }
                strncat(dst, tempstr, len-1);
        }

-       if(bitparse_find_section('d', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {
+       if(bitparse_find_section(bitstream_version, 'd', &fpga_info_len, &compressed_fpga_stream, output_buffer)) {

                strncat(dst, " at ", len-1);
                for (uint16_t i = 0; i < fpga_info_len; i++) {
                strncat(dst, " at ", len-1);
                for (uint16_t i = 0; i < fpga_info_len; i++) {

-                       char c = (char)get_from_fpga_stream(&compressed_fpga_stream, output_buffer);
+                       char c = (char)get_from_fpga_stream(bitstream_version, &compressed_fpga_stream, output_buffer);

                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }
                        if (i < sizeof(tempstr)) {
                                tempstr[i] = c;
                        }


@@ -481,8 +505,9 @@ void FpgaGatherVersion(int bitstream_version, char *dst, int len)
                strncat(dst, tempstr, len-1);
        }
        
                strncat(dst, tempstr, len-1);
        }
        

-       inflateEnd(&compressed_fpga_stream);
+       strncat(dst, "\n", len-1);

 
 

+       inflateEnd(&compressed_fpga_stream);

 }
 
 
 }
 
 


@@ -533,3 +558,11 @@ void SetAdcMuxFor(uint32_t whichGpio)
 
        HIGH(whichGpio);
 }
 
        HIGH(whichGpio);
 }

+
+void Fpga_print_status(void)
+{
+       Dbprintf("Fgpa");
+       if(downloaded_bitstream == FPGA_BITSTREAM_HF) Dbprintf("  mode.............HF");
+       else if(downloaded_bitstream == FPGA_BITSTREAM_LF) Dbprintf("  mode.............LF");
+       else Dbprintf("  mode.............%d", downloaded_bitstream);
+}