diff --git a/doc/reference/audio/codec.rst b/doc/reference/audio/codec.rst new file mode 100644 index 00000000000..34c9c4a2a30 --- /dev/null +++ b/doc/reference/audio/codec.rst @@ -0,0 +1,22 @@ +.. _audio_codec_api: + +Audio Codec +########### + +Overview +******** + +The Audio Codec API provides access to digital audio codecs. + +Configuration Options +********************* + +Related configuration options: + +* :option:`CONFIG_AUDIO_CODEC` + +API Reference +************* + +.. doxygengroup:: audio_codec_interface + :project: Zephyr diff --git a/doc/reference/audio/dmic.rst b/doc/reference/audio/dmic.rst new file mode 100644 index 00000000000..a4a46d83199 --- /dev/null +++ b/doc/reference/audio/dmic.rst @@ -0,0 +1,22 @@ +.. _audio_dmic_api: + +DMIC +#### + +Overview +******** + +The audio DMIC interface provides access to digital microphones. + +Configuration Options +********************* + +Related configuration options: + +* :option:`CONFIG_AUDIO_DMIC` + +API Reference +************* + +.. doxygengroup:: audio_dmic_interface + :project: Zephyr diff --git a/doc/reference/audio/index.rst b/doc/reference/audio/index.rst new file mode 100644 index 00000000000..0728dd6103a --- /dev/null +++ b/doc/reference/audio/index.rst @@ -0,0 +1,10 @@ +.. _audio_reference: + +Audio +##### + +.. toctree:: + :maxdepth: 1 + + codec.rst + dmic.rst diff --git a/doc/reference/index.rst b/doc/reference/index.rst index 9c795189a7d..a9598fa9fbe 100644 --- a/doc/reference/index.rst +++ b/doc/reference/index.rst @@ -7,6 +7,7 @@ API Reference :maxdepth: 1 terminology.rst + audio/index.rst bluetooth/index.rst kconfig/index.rst crypto/index.rst diff --git a/include/audio/codec.h b/include/audio/codec.h index bff8d2eca2f..64fc0731dd5 100644 --- a/include/audio/codec.h +++ b/include/audio/codec.h @@ -14,6 +14,13 @@ #ifndef ZEPHYR_INCLUDE_AUDIO_CODEC_H_ #define ZEPHYR_INCLUDE_AUDIO_CODEC_H_ +/** + * @brief Abstraction for audio codecs + * + * @defgroup audio_codec_interface Audio Codec Interface + * @{ + */ + #include #ifdef __cplusplus @@ -217,4 +224,8 @@ static inline int audio_codec_apply_properties(struct device *dev) } #endif +/** + * @} + */ + #endif /* ZEPHYR_INCLUDE_AUDIO_CODEC_H_ */ diff --git a/include/audio/dmic.h b/include/audio/dmic.h index 5b51df38acc..ebd01130027 100644 --- a/include/audio/dmic.h +++ b/include/audio/dmic.h @@ -7,9 +7,23 @@ * SPDX-License-Identifier: Apache-2.0 */ +/** + * @file + * @brief Public API header file for Digital Microphones + * + * This file contains the Digital Microphone APIs + */ + #ifndef ZEPHYR_INCLUDE_AUDIO_DMIC_H_ #define ZEPHYR_INCLUDE_AUDIO_DMIC_H_ +/** + * @brief Abstraction for digital microphones + * + * @defgroup audio_dmic_interface Digital Microphone Interface + * @{ + */ + #include #include @@ -276,4 +290,8 @@ static inline int dmic_read(struct device *dev, u8_t stream, void **buffer, } #endif +/** + * @} + */ + #endif /* ZEPHYR_INCLUDE_AUDIO_DMIC_H_ */