aboutsummaryrefslogtreecommitdiffstats
path: root/include/gaudin/lld/gaudin_lld.h
blob: 6512c61c478a8b002d3dd8d56740283025bdd822 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
/*
    ChibiOS/GFX - Copyright (C) 2012, 2013
                 Joel Bodenmann aka Tectu <joel@unormal.org>

    This file is part of ChibiOS/GFX.

    ChibiOS/GFX is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/GFX is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
/**
 * @file    include/gaudin/lld/gaudin_lld.h
 * @brief   GAUDIN - Audio Input driver header file.
 *
 * @defgroup Driver Driver
 * @ingroup GAUDIN
 * @{
 */

#ifndef _GAUDIN_LLD_H
#define _GAUDIN_LLD_H

#include "gfx.h"

#if GFX_USE_GADC || defined(__DOXYGEN__)

/*===========================================================================*/
/* Type definitions                                                          */
/*===========================================================================*/

/**
 * @brief				The structure passed to start a audio conversion
 * @note				We use the structure instead of parameters purely to save
 * 						interrupt stack space which is very limited in some platforms.
 * @{
 */
typedef struct gaudin_params_t {
	uint16_t		channel;
	uint32_t		frequency;
	audin_sample_t	*buffer;
	size_t			bufcount;
	size_t			samplesPerEvent;
	} gaudin_params;
/** @} */

/**
 * @brief				These routines are the callbacks that the driver uses.
 * @details				Defined in the high level GAUDIN code.
 *
 * @iclass
 * @notapi
 *
 * @{
 */

/**
 * @param[in] buffer	The buffer
 * @param[in] n			The amount of samples
 * */
extern void GAUDIN_ISR_CompleteI(audin_sample_t *buffer, size_t n);

extern void GAUDIN_ISR_ErrorI(void);
/**
 * @}
 */

/*===========================================================================*/
/* External declarations.                                                    */
/*===========================================================================*/

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief				Initialise the driver
 *
 * @param[in] paud		Initialisation parameters
 *
 * @api
 */
void gaudin_lld_init(const gaudin_params *paud);

/**
 * @brief				Start the audio input sampling
 *
 * @api
 */
void gadc_lld_start(void);

/**
 * @brief				Stop the audio input sampling
 *
 * @api
 */
void gadc_lld_stop(void);

#ifdef __cplusplus
}
#endif

#endif /* GFX_USE_GADC */

#endif /* _GADC_LLD_H */
/** @} */