jackcartersmith/blackmagic
1
0
Fork 0
Code Issues Pull Requests Releases Activity

doc: efm32: wdog: enable documentation via peripheral_apis

Browse Source
This commit is contained in:
Karl Palsson 2019-06-22 01:02:02 +00:00
parent 093edfb881
commit 35657bdb61
6 changed files with 48 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
include/libopencm3/efm32/common/wdog_common.h
View File

@ -1,3 +1,5 @@
/** @addtogroup wdog_defines
*/
/* /*
* This file is part of the libopencm3 project. * This file is part of the libopencm3 project.
* *
@ -17,12 +19,13 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>. * along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
#ifndef LIBOPENCM3_EFM32_WDOG_H #pragma once
#define LIBOPENCM3_EFM32_WDOG_H
#include <libopencm3/efm32/memorymap.h> #include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h> #include <libopencm3/cm3/common.h>
/**@{*/
#define WDOG_CTRL MMIO32(WDOG_BASE + 0x000) #define WDOG_CTRL MMIO32(WDOG_BASE + 0x000)
#define WDOG_CMD MMIO32(WDOG_BASE + 0x004) #define WDOG_CMD MMIO32(WDOG_BASE + 0x004)
#define WDOG_SYNCBUSY MMIO32(WDOG_BASE + 0x008) #define WDOG_SYNCBUSY MMIO32(WDOG_BASE + 0x008)
@ -72,5 +75,4 @@
#define WDOG_SYNCBUSY_CMD (1 << 1) #define WDOG_SYNCBUSY_CMD (1 << 1)
#define WDOG_SYNCBUSY_CTRL (1 << 0) #define WDOG_SYNCBUSY_CTRL (1 << 0)
#endif /**@}*/

17
include/libopencm3/efm32/common/wdog_common_hglg.h
View File

@ -1,3 +1,5 @@
/** @addtogroup wdog_defines
*/
/* /*
* This file is part of the libopencm3 project. * This file is part of the libopencm3 project.
* *
@ -17,15 +19,13 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>. * along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
/** @cond */ #pragma once
#if defined(LIBOPENCM3_WDOG_H)
/** @endcond */
#ifndef LIBOPENCM3_EFM32_WDOG_COMMON_HGLG_H
#define LIBOPENCM3_EFM32_WDOG_COMMON_HGLG_H
#include <libopencm3/efm32/memorymap.h> #include <libopencm3/efm32/memorymap.h>
#include <libopencm3/cm3/common.h> #include <libopencm3/cm3/common.h>
/**@{*/
#define WDOG_CTRL MMIO32(WDOG_BASE + 0x000) #define WDOG_CTRL MMIO32(WDOG_BASE + 0x000)
#define WDOG_CMD MMIO32(WDOG_BASE + 0x004) #define WDOG_CMD MMIO32(WDOG_BASE + 0x004)
#define WDOG_SYNCBUSY MMIO32(WDOG_BASE + 0x008) #define WDOG_SYNCBUSY MMIO32(WDOG_BASE + 0x008)
@ -75,9 +75,4 @@
#define WDOG_SYNCBUSY_CMD (1 << 1) #define WDOG_SYNCBUSY_CMD (1 << 1)
#define WDOG_SYNCBUSY_CTRL (1 << 0) #define WDOG_SYNCBUSY_CTRL (1 << 0)
#endif /**@}*/
/** @cond */
#else
#warning "wdog_common_hglg.h should not be included explicitly, only via wdog.h"
#endif
/** @endcond */

13
include/libopencm3/efm32/ezr32wg/wdog.h
View File

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

13
include/libopencm3/efm32/hg/wdog.h
View File

@ -1,3 +1,11 @@
/** @defgroup wdog_defines WDOG Defines
*
* @brief <b>Defined Constants and Types for the Watchdog module</b>
*
* @ingroup EFM32HG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/* /*
* This file is part of the libopencm3 project. * This file is part of the libopencm3 project.
* *
@ -15,9 +23,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>. * along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
#ifndef LIBOPENCM3_WDOG_H #pragma once
#define LIBOPENCM3_WDOG_H
#include <libopencm3/efm32/common/wdog_common_hglg.h> #include <libopencm3/efm32/common/wdog_common_hglg.h>
#endif

13
include/libopencm3/efm32/lg/wdog.h
View File

@ -1,3 +1,11 @@
/** @defgroup wdog_defines WDOG Defines
*
* @brief <b>Defined Constants and Types for the Watchdog module</b>
*
* @ingroup EFM32LG_defines
*
* LGPL License Terms @ref lgpl_license
*/
/* /*
* This file is part of the libopencm3 project. * This file is part of the libopencm3 project.
* *
@ -15,9 +23,6 @@
* along with this library. If not, see <http://www.gnu.org/licenses/>. * along with this library. If not, see <http://www.gnu.org/licenses/>.
*/ */
#ifndef LIBOPENCM3_WDOG_H #pragma once
#define LIBOPENCM3_WDOG_H
#include <libopencm3/efm32/common/wdog_common.h> #include <libopencm3/efm32/common/wdog_common.h>
#endif

13
include/libopencm3/efm32/wg/wdog.h
View File

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