RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

drivers/cc110x: Added missing Doxygen comments

Browse Source 
The current stable Doxygen release should no longer complain now
This commit is contained in:
Marian Buschsieweke 2019-09-06 09:10:38 +02:00
parent b389a9c5fa
commit 84acc746dc
No known key found for this signature in database
GPG Key ID: 61F64C6599B1539F
1 changed files with 28 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
drivers/cc110x/include/cc110x_params.h
View File

@ -33,42 +33,64 @@ extern "C" {
* @{
*/
#ifndef CC110X_PARAM_SPI
#define CC110X_PARAM_SPI SPI_DEV(0)
#define CC110X_PARAM_SPI SPI_DEV(0) /**< SPI bus connected to CC110x */
#endif
#ifndef CC110X_PARAM_CS
#define CC110X_PARAM_CS GPIO_PIN(1, 21)
#define CC110X_PARAM_CS GPIO_PIN(1, 21) /**< SPI-CS connected to CC110x */
#endif
#ifndef CC110X_PARAM_GDO0
#define CC110X_PARAM_GDO0 GPIO_PIN(0, 27)
#define CC110X_PARAM_GDO0 GPIO_PIN(0, 27) /**< GPIO connected to CC110x' GDO0 pin */
#endif
#ifndef CC110X_PARAM_GDO2
#define CC110X_PARAM_GDO2 GPIO_PIN(0, 28)
#define CC110X_PARAM_GDO2 GPIO_PIN(0, 28) /**< GPIO connected to CC110x's GDO2 pin */
#endif
#ifndef CC110X_PARAM_SPI_CLOCK
#define CC110X_PARAM_SPI_CLOCK SPI_CLK_5MHZ
#define CC110X_PARAM_SPI_CLOCK SPI_CLK_5MHZ /**< SPI clock frequence to use */
#endif
#ifndef CC110X_PARAM_L2ADDR
/**
* @brief L2 address configure when the driver is initialized
*/
#define CC110X_PARAM_L2ADDR CC110X_L2ADDR_AUTO
#endif
#ifndef CC110X_PARAM_PATABLE
/**
* @brief PA table to use
*
* Choose the one matching the base frequency your transceiver uses, otherwise
* the TX power setting will be incorrect.
*/
#define CC110X_PARAM_PATABLE (&cc110x_patable_868mhz)
#endif
#ifndef CC110X_PARAM_CONFIG
/**
* @brief Default config to apply
*
* If 868 MHz is used as base frequency, you can set this to `NULL`
*/
#define CC110X_PARAM_CONFIG NULL
#endif
#ifndef CC110X_PARAM_CHANNELS
/**
* @brief Default channel map to use
*
* This must match to configuration you have chosen
*/
#define CC110X_PARAM_CHANNELS (&cc110x_chanmap_868mhz_lora)
#endif
#ifndef CC110X_PARAMS
/**
* @brief Default initialization parameters of the CC110x driver
*/
#define CC110X_PARAMS { \
.spi = CC110X_PARAM_SPI, \
.spi_clk = CC110X_PARAM_SPI_CLOCK, \
@ -85,8 +107,7 @@ extern "C" {
/** @} */
/**
* @name CC110X configuration
* @brief Specifies the SPI bus and GPIOs connected to the CC110X transceiver
* @brief CC110X initialization parameters
*/
static const cc110x_params_t cc110x_params[] = {
CC110X_PARAMS