diff options
author | Karl Palsson <karlp@etactica.com> | 2019-06-25 14:24:44 +0300 |
---|---|---|
committer | Karl Palsson <karlp@etactica.com> | 2019-06-26 00:15:19 +0300 |
commit | 531aa7e6b794c45f11b45b7ba203e25c7dfcc530 (patch) | |
tree | d009e887c20106534e01a3e2b74847d700d6ecb1 | |
parent | 75f6cbfd9deff16769491f35aeb062c69feded43 (diff) |
doc: efm32: rmu: include in doxygen generation
Include a stub .c file for shared code generation
-rw-r--r-- | include/libopencm3/efm32/common/rmu_common.h | 10 | ||||
-rw-r--r-- | include/libopencm3/efm32/ezr32wg/rmu.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/lg/rmu.h | 13 | ||||
-rw-r--r-- | include/libopencm3/efm32/wg/rmu.h | 13 | ||||
-rw-r--r-- | lib/efm32/common/rmu_common.c | 15 | ||||
-rw-r--r-- | lib/efm32/ezr32wg/Makefile | 1 | ||||
-rw-r--r-- | lib/efm32/lg/Makefile | 1 | ||||
-rw-r--r-- | lib/efm32/wg/Makefile | 1 |
8 files changed, 51 insertions, 16 deletions
diff --git a/include/libopencm3/efm32/common/rmu_common.h b/include/libopencm3/efm32/common/rmu_common.h index 4a7e721a..96723bb5 100644 --- a/include/libopencm3/efm32/common/rmu_common.h +++ b/include/libopencm3/efm32/common/rmu_common.h @@ -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 - +/**@}*/
\ No newline at end of file diff --git a/include/libopencm3/efm32/ezr32wg/rmu.h b/include/libopencm3/efm32/ezr32wg/rmu.h index f0eab3a9..cad039e4 100644 --- a/include/libopencm3/efm32/ezr32wg/rmu.h +++ b/include/libopencm3/efm32/ezr32wg/rmu.h @@ -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 diff --git a/include/libopencm3/efm32/lg/rmu.h b/include/libopencm3/efm32/lg/rmu.h index 21415073..97c793f7 100644 --- a/include/libopencm3/efm32/lg/rmu.h +++ b/include/libopencm3/efm32/lg/rmu.h @@ -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 diff --git a/include/libopencm3/efm32/wg/rmu.h b/include/libopencm3/efm32/wg/rmu.h index d2ba356b..9cc75419 100644 --- a/include/libopencm3/efm32/wg/rmu.h +++ b/include/libopencm3/efm32/wg/rmu.h @@ -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 diff --git a/lib/efm32/common/rmu_common.c b/lib/efm32/common/rmu_common.c new file mode 100644 index 00000000..1b0a8cfd --- /dev/null +++ b/lib/efm32/common/rmu_common.c @@ -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> + +/**@{*/ + +/**@}*/ + diff --git a/lib/efm32/ezr32wg/Makefile b/lib/efm32/ezr32wg/Makefile index 7b21f0ae..5c26a76f 100644 --- a/lib/efm32/ezr32wg/Makefile +++ b/lib/efm32/ezr32wg/Makefile @@ -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 diff --git a/lib/efm32/lg/Makefile b/lib/efm32/lg/Makefile index 344a75ed..446c6611 100644 --- a/lib/efm32/lg/Makefile +++ b/lib/efm32/lg/Makefile @@ -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 diff --git a/lib/efm32/wg/Makefile b/lib/efm32/wg/Makefile index 38a2163b..596592b5 100644 --- a/lib/efm32/wg/Makefile +++ b/lib/efm32/wg/Makefile @@ -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 |