doc: efm32: i2c: tag for doxygen

Includes a stub .c file until there are some APIs
This commit is contained in:
Karl Palsson 2019-06-25 11:03:22 +00:00
parent 4c01e47aed
commit 25dc3a9b4b
8 changed files with 51 additions and 15 deletions

View File

@ -1,3 +1,5 @@
/** @addtogroup i2c_defines
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,12 +19,13 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_I2C_H
#define LIBOPENCM3_EFM32_I2C_H
#pragma once
#include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h>
/**@{*/
#define I2C_CTRL(base) MMIO32((base) + 0x000)
#define I2C_CMD(base) MMIO32((base) + 0x004)
#define I2C_STATE(base) MMIO32((base) + 0x008)
@ -265,4 +268,4 @@
#define I2C1_IEN I2C_IEN(I2C1)
#define I2C1_ROUTE I2C_ROUTE(I2C1)
#endif
/**@}*/

View File

@ -1,3 +1,11 @@
/** @defgroup i2c_defines I2C Defines
*
* @brief <b>Defined Constants and Types for the I²C module</b>
*
* @ingroup EZR32WG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +25,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_EZR32WG_I2C_H
#define LIBOPENCM3_EFM32_EZR32WG_I2C_H
#pragma once
#include <libopencm3/efm32/common/i2c_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup i2c_defines I2C Defines
*
* @brief <b>Defined Constants and Types for the I²C module</b>
*
* @ingroup EFM32LG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +25,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_LG_I2C_H
#define LIBOPENCM3_EFM32_LG_I2C_H
#pragma once
#include <libopencm3/efm32/common/i2c_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup i2c_defines I2C Defines
*
* @brief <b>Defined Constants and Types for the I²C module</b>
*
* @ingroup EFM32WG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@ -17,9 +25,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef LIBOPENCM3_EFM32_WG_I2C_H
#define LIBOPENCM3_EFM32_WG_I2C_H
#pragma once
#include <libopencm3/efm32/common/i2c_common.h>
#endif

View File

@ -0,0 +1,15 @@
/** @addtogroup i2c_file I2C peripheral API
* @ingroup peripheral_apis
* @brief I²C helper functions.
*
* <b>NO</b> helper functions exist. Only header definitions are available.
* Delete these lines if/when you add actual helper APIs.
* @copyright See @ref lgpl_license
*/
#include <libopencm3/efm32/i2c.h>
/**@{*/
/**@}*/

View File

@ -45,6 +45,7 @@ OBJS += dac_common.o
OBJS += dma_common.o
OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += i2c_common.o
OBJS += prs_common.o
OBJS += timer_common.o

View File

@ -45,6 +45,7 @@ OBJS += dac_common.o
OBJS += dma_common.o
OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += i2c_common.o
OBJS += prs_common.o
OBJS += timer_common.o

View File

@ -45,6 +45,7 @@ OBJS += dac_common.o
OBJS += dma_common.o
OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += i2c_common.o
OBJS += prs_common.o
OBJS += timer_common.o