diff options
Diffstat (limited to 'drivers/staging/echo/oslec.h')
| -rw-r--r-- | drivers/staging/echo/oslec.h | 70 |
1 files changed, 39 insertions, 31 deletions
diff --git a/drivers/staging/echo/oslec.h b/drivers/staging/echo/oslec.h index bad852328a2f..f4175360ce27 100644 --- a/drivers/staging/echo/oslec.h +++ b/drivers/staging/echo/oslec.h @@ -27,8 +27,6 @@ #ifndef __OSLEC_H #define __OSLEC_H -/* TODO: document interface */ - /* Mask bits for the adaption mode */ #define ECHO_CAN_USE_ADAPTION 0x01 #define ECHO_CAN_USE_NLP 0x02 @@ -38,49 +36,59 @@ #define ECHO_CAN_USE_RX_HPF 0x20 #define ECHO_CAN_DISABLE 0x40 -/*! - G.168 echo canceller descriptor. This defines the working state for a line - echo canceller. -*/ +/** + * oslec_state: G.168 echo canceller descriptor. + * + * This defines the working state for a line echo canceller. + */ struct oslec_state; -/*! Create a voice echo canceller context. - \param len The length of the canceller, in samples. - \return The new canceller context, or NULL if the canceller could not be created. -*/ +/** + * oslec_create - Create a voice echo canceller context. + * @len: The length of the canceller, in samples. + * @return: The new canceller context, or NULL if the canceller could not be + * created. + */ struct oslec_state *oslec_create(int len, int adaption_mode); -/*! Free a voice echo canceller context. - \param ec The echo canceller context. -*/ +/** + * oslec_free - Free a voice echo canceller context. + * @ec: The echo canceller context. + */ void oslec_free(struct oslec_state *ec); -/*! Flush (reinitialise) a voice echo canceller context. - \param ec The echo canceller context. -*/ +/** + * oslec_flush - Flush (reinitialise) a voice echo canceller context. + * @ec: The echo canceller context. + */ void oslec_flush(struct oslec_state *ec); -/*! Set the adaption mode of a voice echo canceller context. - \param ec The echo canceller context. - \param adapt The mode. -*/ +/** + * oslec_adaption_mode - set the adaption mode of a voice echo canceller context. + * @ec The echo canceller context. + * @adaption_mode: The mode. + */ void oslec_adaption_mode(struct oslec_state *ec, int adaption_mode); void oslec_snapshot(struct oslec_state *ec); -/*! Process a sample through a voice echo canceller. - \param ec The echo canceller context. - \param tx The transmitted audio sample. - \param rx The received audio sample. - \return The clean (echo cancelled) received sample. -*/ +/** + * oslec_update: Process a sample through a voice echo canceller. + * @ec: The echo canceller context. + * @tx: The transmitted audio sample. + * @rx: The received audio sample. + * + * The return value is the clean (echo cancelled) received sample. + */ int16_t oslec_update(struct oslec_state *ec, int16_t tx, int16_t rx); -/*! Process to high pass filter the tx signal. - \param ec The echo canceller context. - \param tx The transmitted auio sample. - \return The HP filtered transmit sample, send this to your D/A. -*/ +/** + * oslec_hpf_tx: Process to high pass filter the tx signal. + * @ec: The echo canceller context. + * @tx: The transmitted auio sample. + * + * The return value is the HP filtered transmit sample, send this to your D/A. + */ int16_t oslec_hpf_tx(struct oslec_state *ec, int16_t tx); #endif /* __OSLEC_H */ |