mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
479d5a311c
This commits add documentation to the AT86RF2xx params and adds generic exclude patters to the doc check, so that when boards provide custom AT86RF2xx params they do not need to document them again. The reasoning is that the documentation in the central place is sufficient.
110 lines
2.6 KiB
C
110 lines
2.6 KiB
C
/*
|
|
* Copyright (C) 2015 Kaspar Schleiser <kaspar@schleiser.de>
|
|
* 2015 Hauke Petersen <hauke.petersen@fu-berlin.de>
|
|
*
|
|
* 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_at86rf2xx
|
|
* @{
|
|
* @file
|
|
* @brief Default configuration for the AT86RF2xx driver
|
|
*
|
|
* @author Kaspar Schleiser <kaspar@schleiser.de>
|
|
* @author Hauke Petersen <hauke.petersen@fu-berlin.de>
|
|
*/
|
|
|
|
#ifndef AT86RF2XX_PARAMS_H
|
|
#define AT86RF2XX_PARAMS_H
|
|
|
|
#include "at86rf2xx.h"
|
|
#include "board.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @name Set default configuration parameters for the AT86RF2xx driver
|
|
* @{
|
|
*/
|
|
#ifndef AT86RF2XX_PARAM_SPI
|
|
/**
|
|
* @brief SPI bus the AT86RF2xx is connected to
|
|
*/
|
|
#define AT86RF2XX_PARAM_SPI (SPI_DEV(0))
|
|
#endif
|
|
|
|
#ifndef AT86RF2XX_PARAM_SPI_CLK
|
|
/**
|
|
* @brief Clock to drive the SPI bus when speaking with the AT86RF2xx
|
|
*/
|
|
#define AT86RF2XX_PARAM_SPI_CLK (SPI_CLK_5MHZ)
|
|
#endif
|
|
|
|
#ifndef AT86RF2XX_PARAM_CS
|
|
/**
|
|
* @brief GPIO pin the CS pin of the AT86RF2xx is connected to
|
|
*/
|
|
#define AT86RF2XX_PARAM_CS (GPIO_PIN(0, 0))
|
|
#endif
|
|
|
|
#ifndef AT86RF2XX_PARAM_INT
|
|
/**
|
|
* @brief GPIO pin the INT pin of the AT86RF2xx is connected to
|
|
*/
|
|
#define AT86RF2XX_PARAM_INT (GPIO_PIN(0, 1))
|
|
#endif
|
|
|
|
#ifndef AT86RF2XX_PARAM_SLEEP
|
|
/**
|
|
* @brief GPIO pin the SLEEP pin of the AT86RF2xx is connected to
|
|
*/
|
|
#define AT86RF2XX_PARAM_SLEEP (GPIO_PIN(0, 2))
|
|
#endif
|
|
|
|
#ifndef AT86RF2XX_PARAM_RESET
|
|
/**
|
|
* @brief GPIO pin the RESET pin of the AT86RF2xx is connected to
|
|
*/
|
|
#define AT86RF2XX_PARAM_RESET (GPIO_PIN(0, 3))
|
|
#endif
|
|
|
|
#ifndef AT86RF2XX_PARAMS
|
|
/**
|
|
* @brief Parameters to initialize the AT86RF2xx driver with
|
|
*/
|
|
#define AT86RF2XX_PARAMS { .spi = AT86RF2XX_PARAM_SPI, \
|
|
.spi_clk = AT86RF2XX_PARAM_SPI_CLK, \
|
|
.cs_pin = AT86RF2XX_PARAM_CS, \
|
|
.int_pin = AT86RF2XX_PARAM_INT, \
|
|
.sleep_pin = AT86RF2XX_PARAM_SLEEP, \
|
|
.reset_pin = AT86RF2XX_PARAM_RESET }
|
|
#endif
|
|
/**@}*/
|
|
|
|
/**
|
|
* @brief AT86RF231 configuration
|
|
*/
|
|
#if AT86RF2XX_IS_PERIPH
|
|
static const uint8_t at86rf2xx_params[] =
|
|
{
|
|
0 /* dummy value */
|
|
};
|
|
#else
|
|
static const at86rf2xx_params_t at86rf2xx_params[] =
|
|
{
|
|
AT86RF2XX_PARAMS
|
|
};
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* AT86RF2XX_PARAMS_H */
|
|
/** @} */
|