michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doxygen: define groups for drivers

Browse source 
Change-Id: Ibf6b6d8586086de5b288fee1e3b4fb1101716fe1
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2015-10-26 06:18:44 -04:00
commit 75482aae8a
8 changed files with 86 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

10
include/adc.h
View file

@ -28,6 +28,12 @@
#include <stdint.h>
#include <device.h>
/**
* @brief ADC Interface
* @defgroup adc_interface ADC Interface
* @ingroup io_interfaces
* @{
*/
/**
* Callback type.
* ADC_CB_DONE means sampling went fine and is over
@ -164,4 +170,8 @@ static inline int adc_read(struct device *dev, struct adc_seq_table *seq_table)
return api->read(dev, seq_table);
}
/**
* @}
*/
#endif /* __INCLUDE_ADC_H__ */

11
include/gpio.h
View file

@ -18,7 +18,12 @@
#ifndef __GPIO_H__
#define __GPIO_H__
/**
* @brief GPIO Interface
* @defgroup gpio_interface GPIO Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
@ -273,4 +278,8 @@ static inline int gpio_resume(struct device *port)
}
#endif
/**
* @}
*/
#endif /* __GPIO_H__ */

12
include/i2c.h
View file

@ -18,6 +18,13 @@
#ifndef __DRIVERS_I2C_H
#define __DRIVERS_I2C_H
/**
* @brief I2C Interface
* @defgroup i2c_interface I2C Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
@ -267,4 +274,9 @@ static inline int i2c_resume(struct device *dev)
}
#endif
/**
* @}
*/
#endif /* __DRIVERS_I2C_H */

11
include/ipi.h
View file

@ -19,6 +19,13 @@
#ifndef __INCipih
#define __INCipih
/**
* @brief IPI Interface
* @defgroup ipi_interface IPI Interface
* @ingroup io_interfaces
* @{
*/
#include <nanokernel.h>
#include <device.h>
@ -161,5 +168,7 @@ static inline int ipi_set_enabled(struct device *ipidev, int enable)
return api->set_enabled(ipidev, enable);
}
/**
* @}
*/
#endif /* __INCipih */

11
include/pinmux.h
View file

@ -18,6 +18,13 @@
#ifndef __INCLUDE_PINMUX_H
#define __INCLUDE_PINMUX_H
/**
* @brief Pinmux Interface
* @defgroup pinmux_interface Pinmux Interface
* @ingroup io_interfaces
* @{
*/
#include <stdint.h>
#include <device.h>
@ -57,4 +64,8 @@ static inline uint32_t pinmux_get_pin(struct device *dev,
return api->get(dev, pin, func);
}
/**
*
* @}
*/
#endif /* __INCLUDE_PINMUX_H */

11
include/pwm.h
View file

@ -22,6 +22,13 @@
#ifndef __PWM_H__
#define __PWM_H__
/**
* @brief PWM Interface
* @defgroup pwm_interface PWM Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
@ -194,4 +201,8 @@ static inline int pwm_resume(struct device *dev)
}
#endif
/**
* @}
*/
#endif /* __PWM_H__ */

11
include/spi.h
View file

@ -19,6 +19,13 @@
#ifndef __SPI_H__
#define __SPI_H__
/**
* @brief SPI Interface
* @defgroup spi_interface SPI Interface
* @ingroup io_interfaces
* @{
*/
#include <stdint.h>
#include <stddef.h>
#include <device.h>
@ -213,4 +220,8 @@ static inline int spi_resume(struct device *dev)
}
#endif
/**
* @}
*/
#endif /* __SPI_H__ */

11
include/uart.h
View file

@ -19,6 +19,13 @@
#ifndef __INCuarth
#define __INCuarth
/**
* @brief UART Interface
* @defgroup uart_interface UART Interface
* @ingroup io_interfaces
* @{
*/
#ifdef __cplusplus
extern "C" {
#endif
@ -415,4 +422,8 @@ static inline unsigned int uart_irq_get(struct device *dev)
}
#endif
/**
* @}
*/
#endif /* __INCuarth */