1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
RIOT/drivers/dfplayer/include/dfplayer_params.h
Marian Buschsieweke e3bef10f3b
drivers/dfplayer: fix doc & C++ boilerplate
- Fix unbalanced groups
- Add missing doc
- Fix C++ `extern "C" { ... }` boilerplate
2021-07-20 22:18:21 +02:00

77 lines
1.8 KiB
C

/*
* Copyright 2019 Marian Buschsieweke
*
* This file is subject to the terms and conditions of the GNU Lesser
* General Public License v2.1. See the file LICENSE in the top level
* directory for more details.
*/
/**
* @ingroup drivers_dfplayer
* @{
*
* @file
* @brief Default configuration for the DFPlayer Mini driver
*
* @author Marian Buschsieweke <marian.buschsieweke@ovgu.de>
*/
#ifndef DFPLAYER_PARAMS_H
#define DFPLAYER_PARAMS_H
#include "board.h"
#include "dfplayer_types.h"
#include "kernel_defines.h"
#ifdef __cplusplus
extern "C" {
#endif
/**
* @name Default configuration parameters for the DFPlayer Mini driver
* @{
*/
#ifndef DFPLAYER_PARAM_UART
#define DFPLAYER_PARAM_UART (UART_DEV(0)) /**< The UART device connected to the DFPlayer Mini */
#endif
#ifndef DFPLAYER_PARAM_BUSY_PIN
#define DFPLAYER_PARAM_BUSY_PIN (GPIO_UNDEF) /**< The GPIO connected to the busy pin of the DFPlayer Mini */
#endif
#ifndef DFPLAYER_PARAM_VOLUME
#define DFPLAYER_PARAM_VOLUME (15) /**< The volume to set during initialization */
#endif
#ifndef DFPLAYER_PARAMS
/**
* @brief Default initialization parameters of the DFPlayer Mini driver
*/
#define DFPLAYER_PARAMS {\
.uart = DFPLAYER_PARAM_UART, \
.busy_pin = DFPLAYER_PARAM_BUSY_PIN, \
.volume = DFPLAYER_PARAM_VOLUME, \
}
#endif
/**@}*/
/**
* @brief DFPlayer Mini configuration
*/
static const dfplayer_params_t dfplayer_params[] =
{
DFPLAYER_PARAMS
};
/**
* @brief Number of DFPlayer descriptors present
*/
#define DFPLAYER_NUMOF ARRAY_SIZE(dfplayer_params)
#ifdef __cplusplus
}
#endif
#endif /* DFPLAYER_PARAMS_H */
/** @} */