git.zerfleddert.de Git - proxmark3-svn/blob - armsrc/lfsampling.c

   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 //-----------------------------------------------------------------------------
   6 // Miscellaneous routines for low frequency sampling.
   7 //-----------------------------------------------------------------------------
   8
   9 #include "proxmark3.h"
  10 #include "apps.h"
  11 #include "util.h"
  12 #include "string.h"
  13 #include "lfsampling.h"
  14 #include "usb_cdc.h"    // for usb_poll_validate_length
  15 //#include "ticks.h"            // for StartTicks
  16
  17 sample_config config = { 1, 8, 1, 95, 0 } ;
  18
  19 void printConfig()
  20 {
  21         Dbprintf("LF Sampling config: ");
  22         Dbprintf("  [q] divisor:           %d ", config.divisor);
  23         Dbprintf("  [b] bps:               %d ", config.bits_per_sample);
  24         Dbprintf("  [d] decimation:        %d ", config.decimation);
  25         Dbprintf("  [a] averaging:         %d ", config.averaging);
  26         Dbprintf("  [t] trigger threshold: %d ", config.trigger_threshold);
  27 }
  28
  29
  30 /**
  31  * Called from the USB-handler to set the sampling configuration
  32  * The sampling config is used for std reading and snooping.
  33  *
  34  * Other functions may read samples and ignore the sampling config,
  35  * such as functions to read the UID from a prox tag or similar.
  36  *
  37  * Values set to '0' implies no change (except for averaging)
  38  * @brief setSamplingConfig
  39  * @param sc
  40  */
  41 void setSamplingConfig(sample_config *sc)
  42 {
  43         if(sc->divisor != 0) config.divisor = sc->divisor;
  44         if(sc->bits_per_sample!= 0) config.bits_per_sample= sc->bits_per_sample;
  45         if(sc->decimation!= 0) config.decimation= sc->decimation;
  46         if(sc->trigger_threshold != -1) config.trigger_threshold= sc->trigger_threshold;
  47
  48         config.averaging= sc->averaging;
  49         if(config.bits_per_sample > 8)  config.bits_per_sample = 8;
  50         if(config.decimation < 1)       config.decimation = 1;
  51
  52         printConfig();
  53 }
  54
  55 sample_config* getSamplingConfig()
  56 {
  57         return &config;
  58 }
  59
  60 typedef struct {
  61         uint8_t * buffer;
  62         uint32_t numbits;
  63         uint32_t position;
  64 } BitstreamOut;
  65
  66 /**
  67  * @brief Pushes bit onto the stream
  68  * @param stream
  69  * @param bit
  70  */
  71 void pushBit( BitstreamOut* stream, uint8_t bit)
  72 {
  73         int bytepos = stream->position >> 3; // divide by 8
  74         int bitpos = stream->position & 7;
  75         *(stream->buffer+bytepos) |= (bit > 0) <<  (7 - bitpos);
  76         stream->position++;
  77         stream->numbits++;
  78 }
  79
  80 /**
  81 * Setup the FPGA to listen for samples. This method downloads the FPGA bitstream
  82 * if not already loaded, sets divisor and starts up the antenna.
  83 * @param divisor : 1, 88> 255 or negative ==> 134.8 KHz
  84 *                                  0 or 95 ==> 125 KHz
  85 *
  86 **/
  87 void LFSetupFPGAForADC(int divisor, bool lf_field)
  88 {
  89         FpgaDownloadAndGo(FPGA_BITSTREAM_LF);
  90         if ( (divisor == 1) || (divisor < 0) || (divisor > 255) )
  91                 FpgaSendCommand(FPGA_CMD_SET_DIVISOR, 88); //134.8Khz
  92         else if (divisor == 0)
  93                 FpgaSendCommand(FPGA_CMD_SET_DIVISOR, 95); //125Khz
  94         else
  95                 FpgaSendCommand(FPGA_CMD_SET_DIVISOR, divisor);
  96
  97         FpgaWriteConfWord(FPGA_MAJOR_MODE_LF_ADC | (lf_field ? FPGA_LF_ADC_READER_FIELD : 0));
  98
  99         // Connect the A/D to the peak-detected low-frequency path.
 100         SetAdcMuxFor(GPIO_MUXSEL_LOPKD);
 101         // Give it a bit of time for the resonant antenna to settle.
 102         SpinDelay(50);
 103         // Now set up the SSC to get the ADC samples that are now streaming at us.
 104         FpgaSetupSsc();
 105 }
 106
 107 /**
 108  * Does the sample acquisition. If threshold is specified, the actual sampling
 109  * is not commenced until the threshold has been reached.
 110  * This method implements decimation and quantization in order to
 111  * be able to provide longer sample traces.
 112  * Uses the following global settings:
 113  * @param decimation - how much should the signal be decimated. A decimation of N means we keep 1 in N samples, etc.
 114  * @param bits_per_sample - bits per sample. Max 8, min 1 bit per sample.
 115  * @param averaging If set to true, decimation will use averaging, so that if e.g. decimation is 3, the sample
 116  * value that will be used is the average value of the three samples.
 117  * @param trigger_threshold - a threshold. The sampling won't commence until this threshold has been reached. Set
 118  * to -1 to ignore threshold.
 119  * @param silent - is true, now outputs are made. If false, dbprints the status
 120  * @return the number of bits occupied by the samples.
 121  */
 122 uint32_t DoAcquisition(uint8_t decimation, uint32_t bits_per_sample, bool averaging, int trigger_threshold, bool silent)
 123 {
 124         //.
 125         uint8_t *dest = BigBuf_get_addr();
 126     int bufsize = BigBuf_max_traceLen();
 127
 128         //memset(dest, 0, bufsize); //creates issues with cmdread (marshmellow)
 129
 130         if(bits_per_sample < 1) bits_per_sample = 1;
 131         if(bits_per_sample > 8) bits_per_sample = 8;
 132
 133         if(decimation < 1) decimation = 1;
 134
 135         // Use a bit stream to handle the output
 136         BitstreamOut data = { dest , 0, 0};
 137         int sample_counter = 0;
 138         uint8_t sample = 0;
 139         //If we want to do averaging
 140         uint32_t sample_sum =0 ;
 141         uint32_t sample_total_numbers =0 ;
 142         uint32_t sample_total_saved =0 ;
 143
 144         while(!BUTTON_PRESS() && !usb_poll_validate_length() ) {
 145                 WDT_HIT();
 146                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_TXRDY) {
 147                         AT91C_BASE_SSC->SSC_THR = 0x43;
 148                         LED_D_ON();
 149                 }
 150                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_RXRDY) {
 151                         sample = (uint8_t)AT91C_BASE_SSC->SSC_RHR;
 152                         LED_D_OFF();
 153                         // threshold either high or low values 128 = center 0.  if trigger = 178
 154                         if ((trigger_threshold > 0) && (sample < (trigger_threshold+128)) && (sample > (128-trigger_threshold))) //
 155                                 continue;
 156
 157                         trigger_threshold = 0;
 158                         sample_total_numbers++;
 159
 160                         if(averaging)
 161                         {
 162                                 sample_sum += sample;
 163                         }
 164                         //Check decimation
 165                         if(decimation > 1)
 166                         {
 167                                 sample_counter++;
 168                                 if(sample_counter < decimation) continue;
 169                                 sample_counter = 0;
 170                         }
 171                         //Averaging
 172                         if(averaging && decimation > 1) {
 173                                 sample = sample_sum / decimation;
 174                                 sample_sum =0;
 175                         }
 176                         //Store the sample
 177                         sample_total_saved ++;
 178                         if(bits_per_sample == 8){
 179                                 dest[sample_total_saved-1] = sample;
 180                                 data.numbits = sample_total_saved << 3;//Get the return value correct
 181                                 if(sample_total_saved >= bufsize) break;
 182                         }
 183                         else{
 184                                 pushBit(&data, sample & 0x80);
 185                                 if(bits_per_sample > 1) pushBit(&data, sample & 0x40);
 186                                 if(bits_per_sample > 2) pushBit(&data, sample & 0x20);
 187                                 if(bits_per_sample > 3) pushBit(&data, sample & 0x10);
 188                                 if(bits_per_sample > 4) pushBit(&data, sample & 0x08);
 189                                 if(bits_per_sample > 5) pushBit(&data, sample & 0x04);
 190                                 if(bits_per_sample > 6) pushBit(&data, sample & 0x02);
 191                                 //Not needed, 8bps is covered above
 192                                 //if(bits_per_sample > 7)       pushBit(&data, sample & 0x01);
 193                                 if((data.numbits >> 3) +1  >= bufsize) break;
 194                         }
 195                 }
 196         }
 197
 198         if(!silent)
 199         {
 200                 Dbprintf("Done, saved %d out of %d seen samples at %d bits/sample",sample_total_saved, sample_total_numbers,bits_per_sample);
 201                 Dbprintf("buffer samples: %02x %02x %02x %02x %02x %02x %02x %02x ...",
 202                                         dest[0], dest[1], dest[2], dest[3], dest[4], dest[5], dest[6], dest[7]);
 203         }
 204         return data.numbits;
 205 }
 206 /**
 207  * @brief Does sample acquisition, ignoring the config values set in the sample_config.
 208  * This method is typically used by tag-specific readers who just wants to read the samples
 209  * the normal way
 210  * @param trigger_threshold
 211  * @param silent
 212  * @return number of bits sampled
 213  */
 214 uint32_t DoAcquisition_default(int trigger_threshold, bool silent)
 215 {
 216         return DoAcquisition(1,8,0,trigger_threshold,silent);
 217 }
 218 uint32_t DoAcquisition_config( bool silent)
 219 {
 220         return DoAcquisition(config.decimation
 221                                   ,config.bits_per_sample
 222                                   ,config.averaging
 223                                   ,config.trigger_threshold
 224                                   ,silent);
 225 }
 226
 227 uint32_t ReadLF(bool activeField, bool silent)
 228 {
 229         if (!silent) printConfig();
 230         LFSetupFPGAForADC(config.divisor, activeField);
 231         // Now call the acquisition routine
 232         return DoAcquisition_config(silent);
 233 }
 234
 235 /**
 236 * Initializes the FPGA for reader-mode (field on), and acquires the samples.
 237 * @return number of bits sampled
 238 **/
 239 uint32_t SampleLF(bool printCfg)
 240 {
 241         uint32_t ret = ReadLF(true, printCfg);
 242         FpgaWriteConfWord(FPGA_MAJOR_MODE_OFF);
 243         return ret;
 244 }
 245 /**
 246 * Initializes the FPGA for snoop-mode (field off), and acquires the samples.
 247 * @return number of bits sampled
 248 **/
 249
 250 uint32_t SnoopLF()
 251 {
 252         uint32_t ret = ReadLF(false, true);
 253         FpgaWriteConfWord(FPGA_MAJOR_MODE_OFF);
 254         return ret;
 255 }
 256
 257 /**
 258 * acquisition of T55x7 LF signal. Similart to other LF, but adjusted with @marshmellows thresholds
 259 * the data is collected in BigBuf.
 260 **/
 261 void doT55x7Acquisition(size_t sample_size) {
 262
 263         #define T55xx_READ_UPPER_THRESHOLD 128+60  // 60 grph
 264         #define T55xx_READ_LOWER_THRESHOLD 128-60  // -60 grph
 265         #define T55xx_READ_TOL   5
 266
 267         uint8_t *dest = BigBuf_get_addr();
 268         uint16_t bufsize = BigBuf_max_traceLen();
 269
 270         if ( bufsize > sample_size )
 271                 bufsize = sample_size;
 272
 273         uint16_t i = 0;
 274         bool startFound = false;
 275         bool highFound = false;
 276         bool lowFound = false;
 277         uint8_t curSample = 0;
 278         uint8_t lastSample = 0;
 279         uint16_t skipCnt = 0;
 280         while(!BUTTON_PRESS() && !usb_poll_validate_length() && skipCnt<1000 && i<bufsize ) {
 281                 WDT_HIT();
 282                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_TXRDY) {
 283                         AT91C_BASE_SSC->SSC_THR = 0x43;
 284                         LED_D_ON();
 285                 }
 286                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_RXRDY) {
 287                         curSample = (uint8_t)AT91C_BASE_SSC->SSC_RHR;
 288                         LED_D_OFF();
 289
 290                         // skip until the first high sample above threshold
 291                         if (!startFound && curSample > T55xx_READ_UPPER_THRESHOLD) {
 292                                 //if (curSample > lastSample)
 293                                 //      lastSample = curSample;
 294                                 highFound = true;
 295                         } else if (!highFound) {
 296                                 skipCnt++;
 297                                 continue;
 298                         }
 299                         // skip until the first Low sample below threshold
 300                         if (!startFound && curSample < T55xx_READ_LOWER_THRESHOLD) {
 301                                 //if (curSample > lastSample)
 302                                 lastSample = curSample;
 303                                 lowFound = true;
 304                         } else if (!lowFound) {
 305                                 skipCnt++;
 306                                 continue;
 307                         }
 308
 309
 310                         // skip until first high samples begin to change
 311                         if (startFound || curSample > T55xx_READ_LOWER_THRESHOLD+T55xx_READ_TOL){
 312                                 // if just found start - recover last sample
 313                                 if (!startFound) {
 314                                         dest[i++] = lastSample;
 315                                         startFound = true;
 316                                 }
 317                                 // collect samples
 318                                 dest[i++] = curSample;
 319                         }
 320                 }
 321         }
 322 }
 323
 324 /**
 325 * acquisition of Cotag LF signal. Similart to other LF,  since the Cotag has such long datarate RF/384
 326 * and is Manchester?,  we directly gather the manchester data into bigbuff
 327 **/
 328 #define COTAG_T1 384
 329 #define COTAG_T2 (COTAG_T1>>1)
 330 #define COTAG_ONE_THRESHOLD 128+30
 331 #define COTAG_ZERO_THRESHOLD 128-30
 332 #ifndef COTAG_BITS
 333 #define COTAG_BITS 264
 334 #endif
 335 void doCotagAcquisition(size_t sample_size) {
 336
 337         uint8_t *dest = BigBuf_get_addr();
 338         uint16_t bufsize = BigBuf_max_traceLen();
 339
 340         if ( bufsize > sample_size )
 341                 bufsize = sample_size;
 342
 343         dest[0] = 0;
 344         uint8_t sample = 0, firsthigh = 0, firstlow = 0;
 345         uint16_t i = 0;
 346
 347         while (!BUTTON_PRESS() && !usb_poll_validate_length() && (i < bufsize) ) {
 348                 WDT_HIT();
 349                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_TXRDY) {
 350                         AT91C_BASE_SSC->SSC_THR = 0x43;
 351                         LED_D_ON();
 352                 }
 353
 354                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_RXRDY) {
 355                         sample = (uint8_t)AT91C_BASE_SSC->SSC_RHR;
 356                         LED_D_OFF();
 357
 358                         // find first peak
 359                         if ( !firsthigh ) {
 360                                 if (sample < COTAG_ONE_THRESHOLD)
 361                                         continue;
 362                                 firsthigh = 1;
 363                         }
 364                         if ( !firstlow ){
 365                                 if (sample > COTAG_ZERO_THRESHOLD )
 366                                         continue;
 367                                 firstlow = 1;
 368                         }
 369
 370                         ++i;
 371
 372                         if ( sample > COTAG_ONE_THRESHOLD)
 373                                 dest[i] = 255;
 374                         else if ( sample < COTAG_ZERO_THRESHOLD)
 375                                 dest[i] = 0;
 376                         else
 377                                 dest[i] = dest[i-1];
 378                 }
 379         }
 380 }
 381
 382 uint32_t doCotagAcquisitionManchester() {
 383
 384         uint8_t *dest = BigBuf_get_addr();
 385         uint16_t bufsize = BigBuf_max_traceLen();
 386
 387         if ( bufsize > COTAG_BITS )
 388                 bufsize = COTAG_BITS;
 389
 390         dest[0] = 0;
 391         uint8_t sample = 0, firsthigh = 0, firstlow = 0;
 392         uint16_t sample_counter = 0, period = 0;
 393         uint8_t curr = 0, prev = 0;
 394
 395         while (!BUTTON_PRESS() && !usb_poll_validate_length() && (sample_counter < bufsize) ) {
 396                 WDT_HIT();
 397                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_TXRDY) {
 398                         AT91C_BASE_SSC->SSC_THR = 0x43;
 399                         LED_D_ON();
 400                 }
 401
 402                 if (AT91C_BASE_SSC->SSC_SR & AT91C_SSC_RXRDY) {
 403                         sample = (uint8_t)AT91C_BASE_SSC->SSC_RHR;
 404                         LED_D_OFF();
 405
 406                         // find first peak
 407                         if ( !firsthigh ) {
 408                                 if (sample < COTAG_ONE_THRESHOLD)
 409                                         continue;
 410                                 firsthigh = 1;
 411                         }
 412
 413                         if ( !firstlow ){
 414                                 if (sample > COTAG_ZERO_THRESHOLD )
 415                                         continue;
 416                                 firstlow = 1;
 417                         }
 418
 419                         // set sample 255, 0,  or previous
 420                         if ( sample > COTAG_ONE_THRESHOLD){
 421                                 prev = curr;
 422                                 curr = 1;
 423                         }
 424                         else if ( sample < COTAG_ZERO_THRESHOLD) {
 425                                 prev = curr;
 426                                 curr = 0;
 427                         }
 428                         else {
 429                                 curr = prev;
 430                         }
 431
 432                         // full T1 periods,
 433                         if ( period > 0 ) {
 434                                 --period;
 435                                 continue;
 436                         }
 437
 438                         dest[sample_counter] = curr;
 439                         ++sample_counter;
 440                         period = COTAG_T1;
 441                 }
 442         }
 443         return sample_counter;
 444 }