doc: efm32: msc: tag for doxygen inclusion

Includes a stub .c file to trigger common code generation
This commit is contained in:
Karl Palsson 2019-06-25 11:18:44 +00:00
parent c92f3dc0ad
commit 75f6cbfd9d
8 changed files with 51 additions and 16 deletions

View File

@ -1,3 +1,5 @@
/** @addtogroup msc_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_MSC_H
#define LIBOPENCM3_EFM32_MSC_H
#pragma once
#include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h>
/**@{*/
#define MSC_CTRL MMIO32(MSC_BASE + 0x000)
#define MSC_READCTRL MMIO32(MSC_BASE + 0x004)
#define MSC_WRITECTRL MMIO32(MSC_BASE + 0x008)
@ -150,5 +153,4 @@
#define MSC_MASSLOCK_LOCKKEY_LOCK MSC_MASSLOCK_LOCKKEY(0)
#define MSC_MASSLOCK_LOCKKEY_UNLOCK MSC_MASSLOCK_LOCKKEY(0x631A)
#endif
/**@}*/

View File

@ -1,3 +1,11 @@
/** @defgroup msc_defines MSC Defines
*
* @brief <b>Defined Constants and Types for the Memory Systems Controller</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_MSC_H
#define LIBOPENCM3_EFM32_EZR32WG_MSC_H
#pragma once
#include <libopencm3/efm32/common/msc_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup msc_defines MSC Defines
*
* @brief <b>Defined Constants and Types for the Memory Systems Controller</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_MSC_H
#define LIBOPENCM3_EFM32_LG_MSC_H
#pragma once
#include <libopencm3/efm32/common/msc_common.h>
#endif

View File

@ -1,3 +1,11 @@
/** @defgroup msc_defines MSC Defines
*
* @brief <b>Defined Constants and Types for the Memory Systems Controller</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_MSC_H
#define LIBOPENCM3_EFM32_WG_MSC_H
#pragma once
#include <libopencm3/efm32/common/msc_common.h>
#endif

View File

@ -0,0 +1,15 @@
/** @addtogroup msc_file MSC peripheral API
* @ingroup peripheral_apis
* @brief Memory Systems Controller 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/msc.h>
/**@{*/
/**@}*/

View File

@ -47,6 +47,7 @@ OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += i2c_common.o
OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += timer_common.o

View File

@ -47,6 +47,7 @@ OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += i2c_common.o
OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += timer_common.o

View File

@ -47,6 +47,7 @@ OBJS += emu_common.o
OBJS += gpio_common.o
OBJS += i2c_common.o
OBJS += letimer_common.o
OBJS += msc_common.o
OBJS += prs_common.o
OBJS += timer_common.o