riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #4315 from haukepetersen/doc_periph_fixes

Browse Source 
doc: various fixes related to 'periph'
This commit is contained in:
Hauke Petersen 2015-11-19 22:59:26 +01:00
commit 421e69030a
19 changed files with 49 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
cpu/kinetis_common/include/periph_cpu.h
View File

@ -38,10 +38,15 @@ typedef uint16_t gpio_t;
*/ */
#define GPIO_UNDEF (0xffff) #define GPIO_UNDEF (0xffff)
/**
* @brief Definition of pin and port positions in the gpio_t type
* @{
*/
#define GPIO_PORT_SHIFT (8) #define GPIO_PORT_SHIFT (8)
#define GPIO_PORT_MASK (0xff << (GPIO_PORT_SHIFT)) #define GPIO_PORT_MASK (0xff << (GPIO_PORT_SHIFT))
#define GPIO_PIN_SHIFT (0) #define GPIO_PIN_SHIFT (0)
#define GPIO_PIN_MASK (0xff << (GPIO_PIN_SHIFT)) #define GPIO_PIN_MASK (0xff << (GPIO_PIN_SHIFT))
/** @} */
/** /**
* @brief Define a CPU specific GPIO pin generator macro * @brief Define a CPU specific GPIO pin generator macro

2
cpu/samd21/include/periph_cpu.h
View File

@ -92,7 +92,7 @@ typedef struct {
* @brief PWM device configuration data structure * @brief PWM device configuration data structure
*/ */
typedef struct { typedef struct {
Tcc *dev; /*< TCC device to use */ Tcc *dev; /**< TCC device to use */
pwm_conf_chan_t chan[2]; /**< channel configuration */ pwm_conf_chan_t chan[2]; /**< channel configuration */
} pwm_conf_t; } pwm_conf_t;

2
doc/doxygen/src/mainpage.md
View File

@ -138,7 +138,7 @@ switching) code. For most CPUs you will also find the linker scripts in the
`ldscripts` sub-directory. `ldscripts` sub-directory.
In the `periph` sub-directory of each CPU you can find the implementations of In the `periph` sub-directory of each CPU you can find the implementations of
the CPU's peripheral drivers like SPI, UART, GPIO, etc. See @ref driver_periph the CPU's peripheral drivers like SPI, UART, GPIO, etc. See @ref drivers_periph
for their API documentation. for their API documentation.
Many CPUs share a certain amount of their code (e.g. all ARM Cortex-M based Many CPUs share a certain amount of their code (e.g. all ARM Cortex-M based

4
drivers/include/adc_legacy.h
View File

@ -10,8 +10,8 @@
* @defgroup drivers_adc ADC * @defgroup drivers_adc ADC
* @ingroup drivers * @ingroup drivers
* @brief Generic interface for ADC drivers * @brief Generic interface for ADC drivers
* @deprecated This interface is obsolete. Use the @ref driver_periph_adc * @deprecated This interface is obsolete. Use the @ref drivers_periph_adc
* interface in @ref driver_periph instead. * interface in @ref drivers_periph instead.
* *
* @author Oliver Hahm <oliver.hahm@inria.fr> * @author Oliver Hahm <oliver.hahm@inria.fr>
* *

4
drivers/include/periph/adc.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_adc ADC * @defgroup drivers_periph_adc ADC
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level ADC peripheral driver * @brief Low-level ADC peripheral driver
* @{ * @{
* *

4
drivers/include/periph/cpuid.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_cpuid CPUID * @defgroup drivers_periph_cpuid CPUID
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level CPU ID peripheral driver * @brief Low-level CPU ID peripheral driver
* *
* Provides access the CPU's serial number * Provides access the CPU's serial number

4
drivers/include/periph/dac.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_dac DAC * @defgroup drivers_periph_dac DAC
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level DAC peripheral driver * @brief Low-level DAC peripheral driver
* *
* @{ * @{

6
drivers/include/periph/dev_enums.h
View File

@ -7,15 +7,15 @@
*/ */
/** /**
* @ingroup driver_periph * @ingroup drivers_periph
* *
* @{ * @{
* @file * @file
* @brief Device enumerations for backward compatibility with existing * @brief Device enumerations for backward compatibility with existing
* peripheral driver implementations * peripheral driver implementations
* *
* TODO: Remove this file once all peripheral drivers are ported to the more * @todo Remove this file once all peripheral drivers are ported to the
* efficient implementations style * more efficient implementations style
* *
* @author Hauke Petersen <hauke.petersen@fu-berlin.de> * @author Hauke Petersen <hauke.petersen@fu-berlin.de>
*/ */

18
drivers/include/periph/doc.txt
View File

@ -1,5 +1,5 @@
/* /*
* Copyright (C) 2013 Freie Universität Berlin * Copyright (C) 2013-2015 Freie Universität Berlin
* *
* This file is subject to the terms and conditions of the GNU Lesser * 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 * General Public License v2.1. See the file LICENSE in the top level
@ -7,11 +7,17 @@
*/ */
/** /**
* @defgroup driver_periph Peripheral drivers * @defgroup drivers_periph Peripheral Driver Interface
* @ingroup drivers * @ingroup drivers
* @brief Low-level peripheral drivers * @brief Low-level peripheral driver interface for vendor and platform
* independent access to MCU peripherals as UART, SPI, etc
* *
* The module contains the low-level peripheral driver layer. It consists of a set * The module contains the low-level peripheral driver interface. This interface
* of platform independent interface definitions and cpu specific implementations * defines a standardized interface to access MCU peripherals that is not tied
* for every targeted platform. * to any specific vendor, platform or architecture.
*
* @todo describe concept in detail
* @todo link to driver model
* @todo describe/link implementation guide
* @todo list best practices
*/ */

4
drivers/include/periph/gpio.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_gpio GPIO * @defgroup drivers_periph_gpio GPIO
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level GPIO peripheral driver * @brief Low-level GPIO peripheral driver
* *
* @{ * @{

4
drivers/include/periph/i2c.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_i2c I2C * @defgroup drivers_periph_i2c I2C
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level I2C peripheral driver * @brief Low-level I2C peripheral driver
* *
* @{ * @{

4
drivers/include/periph/pwm.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_pwm PWM * @defgroup drivers_periph_pwm PWM
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level PWM peripheral driver * @brief Low-level PWM peripheral driver
* *
* @{ * @{

4
drivers/include/periph/random.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_random Random * @defgroup drivers_periph_random Random
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level (pseudo) random number generator driver * @brief Low-level (pseudo) random number generator driver
* *
* The quality of the random data read from this interface is highly * The quality of the random data read from this interface is highly

4
drivers/include/periph/rtc.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_rtc RTC * @defgroup drivers_periph_rtc RTC
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level RTC (Real Time Clock) peripheral driver * @brief Low-level RTC (Real Time Clock) peripheral driver
* *
* @note * @note

4
drivers/include/periph/rtt.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_rtt RTT * @defgroup drivers_periph_rtt RTT
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level RTT (Real Time Timer) peripheral driver * @brief Low-level RTT (Real Time Timer) peripheral driver
* *
* @{ * @{

4
drivers/include/periph/spi.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_spi SPI * @defgroup drivers_periph_spi SPI
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level SPI peripheral driver * @brief Low-level SPI peripheral driver
* *
* The current design of this interface targets implementations that use the SPI in blocking mode. * The current design of this interface targets implementations that use the SPI in blocking mode.

4
drivers/include/periph/timer.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_timer Timer * @defgroup drivers_periph_timer Timer
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level timer peripheral driver * @brief Low-level timer peripheral driver
* @{ * @{
* *

4
drivers/include/periph/uart.h
View File

@ -7,8 +7,8 @@
*/ */
/** /**
* @defgroup driver_periph_uart UART * @defgroup drivers_periph_uart UART
* @ingroup driver_periph * @ingroup drivers_periph
* @brief Low-level UART peripheral driver * @brief Low-level UART peripheral driver
* @{ * @{
* *

2
sys/include/net/gnrc/slip.h
View File

@ -10,7 +10,7 @@
* @defgroup net_gnrc_slip SLIP * @defgroup net_gnrc_slip SLIP
* @ingroup net_gnrc * @ingroup net_gnrc
* @brief Provides a SLIP interface over UART utilizing * @brief Provides a SLIP interface over UART utilizing
* @ref driver_periph_uart. * @ref drivers_periph_uart.
* @see <a href="https://www.ietf.org/rfc/rfc1055">RFC 1055</a> * @see <a href="https://www.ietf.org/rfc/rfc1055">RFC 1055</a>
* @{ * @{
* *