aboutsummaryrefslogtreecommitdiffstats
path: root/src/gadc/gadc_options.h
blob: 18c5038cb07dde96087363433c4c9fd64d699ba0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/*
 * This file is subject to the terms of the GFX License. If a copy of
 * the license was not distributed with this file, you can obtain one at:
 *
 *              http://ugfx.org/license.html
 */

/**
 * @file    src/gadc/gadc_options.h
 * @brief   GADC - Periodic ADC subsystem options header file.
 *
 * @addtogroup GADC
 * @{
 */

#ifndef _GADC_OPTIONS_H
#define _GADC_OPTIONS_H

/**
 * @name    GADC Functionality to be included
 * @{
 */
/**
 * @}
 *
 * @name    GADC Optional Sizing Parameters
 * @{
 */
	/**
	 * @brief   The maximum GADC sample rate
	 * @details	Defaults to 44000
	 * @note	This value must be less than half the maximum sample rate allowed by the CPU.
	 * 			This is to ensure there is time between high speed samples to perform low
	 * 			speed device sampling.
	 */
	#ifndef GADC_MAX_HIGH_SPEED_SAMPLERATE
		#define GADC_MAX_HIGH_SPEED_SAMPLERATE	44000
	#endif
/** @} */

#endif /* _GADC_OPTIONS_H */
/** @} */