armsrc/lfsampling.h

   1 //-----------------------------------------------------------------------------
   2 // Copyright (C) Proxmark3 contributors. See AUTHORS.md for details.
   3 //
   4 // This program is free software: you can redistribute it and/or modify
   5 // it under the terms of the GNU General Public License as published by
   6 // the Free Software Foundation, either version 3 of the License, or
   7 // (at your option) any later version.
   8 //
   9 // This program is distributed in the hope that it will be useful,
  10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 // GNU General Public License for more details.
  13 //
  14 // See LICENSE.txt for the text of the license.
  15 //-----------------------------------------------------------------------------
  16 #ifndef __LFSAMPLING_H
  17 #define __LFSAMPLING_H
  18
  19 #include "common.h"
  20 #include "pm3_cmd.h"
  21
  22 typedef struct {
  23     uint8_t *buffer;
  24     uint32_t numbits;
  25     uint32_t position;
  26 } BitstreamOut_t;
  27
  28 typedef struct {
  29     int dec_counter;
  30     uint32_t sum;
  31     uint32_t counter;
  32     uint32_t total_saved;
  33 } sampling_t;
  34
  35 /**
  36 * acquisition of Cotag LF signal. Similar to other LF,  since the Cotag has such long datarate RF/384
  37 * and is Manchester?,  we directly gather the manchester data into bigbuff
  38 **/
  39 void doCotagAcquisition(void);
  40 uint16_t doCotagAcquisitionManchester(uint8_t *dest, uint16_t destlen);
  41
  42 /**
  43 * acquisition of T55x7 LF signal. Similar to other LF, but adjusted with @marshmellows thresholds
  44 * the data is collected in BigBuf.
  45 **/
  46 void doT55x7Acquisition(size_t sample_size, bool ledcontrol);
  47
  48 /**
  49 * Initializes the FPGA for reader-mode (field on), and acquires the samples.
  50 * @return number of bits sampled
  51 **/
  52 uint32_t SampleLF(bool verbose, uint32_t sample_size, bool ledcontrol);
  53
  54 /**
  55  * Do LF sampling and send samples to the USB
  56  *
  57  * Uses parameters in config. Only bits_per_sample = 8 is working now
  58  *
  59  * @param reader_field - true for reading tags, false for sniffing
  60  * @return sampling result
  61 **/
  62 int ReadLF_realtime(bool reader_field);
  63
  64 /**
  65 * Initializes the FPGA for sniff-mode (field off), and acquires the samples.
  66 * @return number of bits sampled
  67 **/
  68 uint32_t SniffLF(bool verbose, uint32_t sample_size, bool ledcontrol);
  69
  70 uint32_t DoAcquisition(uint8_t decimation, uint8_t bits_per_sample, bool avg, int16_t trigger_threshold,
  71                        bool verbose, uint32_t sample_size, uint32_t cancel_after, int32_t samples_to_skip, bool ledcontrol);
  72
  73 // adds sample size to default options
  74 uint32_t DoPartialAcquisition(int trigger_threshold, bool verbose, uint32_t sample_size, uint32_t cancel_after, bool ledcontrol);
  75
  76 /**
  77  * @brief Does sample acquisition, ignoring the config values set in the sample_config.
  78  * This method is typically used by tag-specific readers who just wants to read the samples
  79  * the normal way
  80  * @param trigger_threshold
  81  * @param verbose
  82  * @return number of bits sampled
  83  */
  84 uint32_t DoAcquisition_default(int trigger_threshold, bool verbose, bool ledcontrol);
  85 /**
  86  * @brief Does sample acquisition, using the config values set in the sample_config.
  87  * @param trigger_threshold
  88  * @param verbose
  89  * @return number of bits sampled
  90  */
  91
  92 uint32_t DoAcquisition_config(bool verbose, uint32_t sample_size, bool ledcontrol);
  93
  94 /**
  95  * Refactoring of lf sampling buffer
  96  */
  97 void initSampleBuffer(uint32_t *sample_size);
  98 void initSampleBufferEx(uint32_t *sample_size, bool use_malloc);
  99 void logSampleSimple(uint8_t sample);
 100 void logSample(uint8_t sample, uint8_t decimation, uint8_t bits_per_sample, bool avg);
 101 uint32_t getSampleCounter(void);
 102
 103 /**
 104 * Setup the FPGA to listen for samples. This method downloads the FPGA bitstream
 105 * if not already loaded, sets divisor and starts up the antenna.
 106 * @param divisor : 1, 88> 255 or negative ==> 134.8 kHz
 107 *                  0 or 95 ==> 125 kHz
 108 *
 109 **/
 110 void LFSetupFPGAForADC(int divisor, bool reader_field);
 111
 112 /**
 113  * Called from the USB-handler to set the sampling configuration
 114  * The sampling config is used for std reading and sniffing.
 115  *
 116  * Other functions may read samples and ignore the sampling config,
 117  * such as functions to read the UID from a prox tag or similar.
 118  *
 119  * Values set to '0' implies no change (except for averaging)
 120  * @brief setSamplingConfig
 121  * @param sc
 122  */
 123 void setSamplingConfig(const sample_config *sc);
 124 void setDefaultSamplingConfig(void);
 125 sample_config *getSamplingConfig(void);
 126
 127 void printLFConfig(void);
 128 void printSamples(void);
 129
 130 #endif // __LFSAMPLING_H