Merge pull request #162 from marshmellow42/CoverityFixes
[legacy-proxmark3.git] / armsrc / lfsampling.h
blobbd8ad1d0833c33de6d53d448bf6ec8a70eb174d4
1 #ifndef LFSAMPLING_H
2 #define LFSAMPLING_H
4 /**
5 * acquisition of T55x7 LF signal. Similart to other LF, but adjusted with @marshmellows thresholds
6 * the data is collected in BigBuf.
7 **/
8 void doT55x7Acquisition(size_t sample_size);
10 /**
11 * Initializes the FPGA for reader-mode (field on), and acquires the samples.
12 * @return number of bits sampled
13 **/
14 uint32_t SampleLF(bool silent);
16 /**
17 * Initializes the FPGA for snoop-mode (field off), and acquires the samples.
18 * @return number of bits sampled
19 **/
21 uint32_t SnoopLF();
23 /**
24 * @brief Does sample acquisition, ignoring the config values set in the sample_config.
25 * This method is typically used by tag-specific readers who just wants to read the samples
26 * the normal way
27 * @param trigger_threshold
28 * @param silent
29 * @return number of bits sampled
31 uint32_t DoAcquisition_default(int trigger_threshold, bool silent);
32 /**
33 * @brief Does sample acquisition, using the config values set in the sample_config.
34 * @param trigger_threshold
35 * @param silent
36 * @return number of bits sampled
39 uint32_t DoAcquisition_config( bool silent);
41 /**
42 * Setup the FPGA to listen for samples. This method downloads the FPGA bitstream
43 * if not already loaded, sets divisor and starts up the antenna.
44 * @param divisor : 1, 88> 255 or negative ==> 134.8 KHz
45 * 0 or 95 ==> 125 KHz
47 **/
48 void LFSetupFPGAForADC(int divisor, bool lf_field);
50 /**
51 * Called from the USB-handler to set the sampling configuration
52 * The sampling config is used for std reading and snooping.
54 * Other functions may read samples and ignore the sampling config,
55 * such as functions to read the UID from a prox tag or similar.
57 * Values set to '0' implies no change (except for averaging)
58 * @brief setSamplingConfig
59 * @param sc
61 void setSamplingConfig(sample_config *sc);
63 sample_config * getSamplingConfig();
65 void printConfig();
68 #endif // LFSAMPLING_H