doc: efm32: rmu: include in doxygen generation

Include a stub .c file for shared code generation
This commit is contained in:
Karl Palsson 2019-06-25 11:24:44 +00:00
parent 75f6cbfd9d
commit 531aa7e6b7
8 changed files with 51 additions and 16 deletions

View File

@ -1,3 +1,5 @@
/** @addtogroup rmu_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_RMU_H
#define LIBOPENCM3_EFM32_RMU_H
#pragma once
#include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h>
/**@{*/
#define RMU_CTRL MMIO32(RMU_BASE + 0x00)
#define RMU_RSTCAUSE MMIO32(RMU_BASE + 0x04)
#define RMU_CMD MMIO32(RMU_BASE + 0x08)
@ -52,5 +55,4 @@
/* RMU_CMD */
#define RMU_CMD_RCCLR (1 << 0)
#endif
/**@}*/

View File

@ -1,3 +1,11 @@
/** @defgroup rmu_defines RMU Defines
*
* @brief <b>Defined Constants and Types for the Reset Management Unit</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_RMU_H
#define LIBOPENCM3_EFM32_EZR32WG_RMU_H
#pragma once
#include <libopencm3/efm32/common/rmu_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup rmu_defines RMU Defines
*
* @brief <b>Defined Constants and Types for the Reset Management Unit</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_RMU_H
#define LIBOPENCM3_EFM32_LG_RMU_H
#pragma once
#include <libopencm3/efm32/common/rmu_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup rmu_defines RMU Defines
*
* @brief <b>Defined Constants and Types for the Reset Management Unit</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_RMU_H
#define LIBOPENCM3_EFM32_WG_RMU_H
#pragma once
#include <libopencm3/efm32/common/rmu_common.h>
#endif

View File

@ -0,0 +1,15 @@
/** @addtogroup rmu_file RMU peripheral API
* @ingroup peripheral_apis
* @brief Reset Management Unit 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/rmu.h>
/**@{*/
/**@}*/

View File

@ -49,6 +49,7 @@ OBJS += i2c_common.o
OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += rmu_common.o
OBJS += timer_common.o
OBJS += usb.o usb_control.o usb_standard.o usb_msc.o

View File

@ -49,6 +49,7 @@ OBJS += i2c_common.o
OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += rmu_common.o
OBJS += timer_common.o
OBJS += usb.o usb_control.o usb_standard.o usb_msc.o

View File

@ -49,6 +49,7 @@ OBJS += i2c_common.o
OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += rmu_common.o
OBJS += timer_common.o
OBJS += usb.o usb_control.o usb_standard.o usb_msc.o