ugfx/include/gaudin/lld/gaudin_lld.h

103 lines
2.1 KiB
C
Raw Normal View History

2013-02-28 23:04:52 +00:00
/*
2013-06-15 11:09:02 +00:00
* This file is subject to the terms of the GFX License. If a copy of
2013-05-03 14:36:17 +00:00
* the license was not distributed with this file, you can obtain one at:
2013-02-28 23:04:52 +00:00
*
2013-05-03 14:36:17 +00:00
* http://chibios-gfx.com/license.html
2013-02-28 23:04:52 +00:00
*/
/**
* @file include/gaudin/lld/gaudin_lld.h
* @brief GAUDIN - Audio Input driver header file.
*
* @defgroup Driver Driver
* @ingroup GAUDIN
* @{
*/
2013-02-28 23:04:52 +00:00
#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;
2013-03-10 19:17:24 +00:00
/** @} */
2013-02-28 23:04:52 +00:00
/**
* @brief These routines are the callbacks that the driver uses.
* @details Defined in the high level GAUDIN code.
*
2013-03-10 19:17:24 +00:00
* @iclass
2013-02-28 23:04:52 +00:00
* @notapi
2013-03-10 19:17:24 +00:00
*
2013-02-28 23:04:52 +00:00
* @{
*/
2013-04-10 11:59:38 +00:00
/**
* @param[in] buffer The buffer
* @param[in] n The amount of samples
* */
2013-02-28 23:04:52 +00:00
extern void GAUDIN_ISR_CompleteI(audin_sample_t *buffer, size_t n);
2013-04-10 11:59:38 +00:00
2013-02-28 23:04:52 +00:00
extern void GAUDIN_ISR_ErrorI(void);
/**
* @}
*/
/*===========================================================================*/
/* External declarations. */
/*===========================================================================*/
#ifdef __cplusplus
extern "C" {
#endif
/**
* @brief Initialise the driver
*
2013-04-10 11:59:38 +00:00
* @param[in] paud Initialisation parameters
*
2013-02-28 23:04:52 +00:00
* @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 */
/** @} */