From f2a9980638a0f52368a0c76fe12ef88e9ecb07c5 Mon Sep 17 00:00:00 2001 From: Karl Palsson Date: Wed, 22 May 2019 00:16:40 +0000 Subject: [PATCH] stm32: doc: rtc: move to peripheral apis Drop some dummy.c files, add some missing groupings and make sure all specifics are included in the generated output. --- lib/stm32/common/rtc_common_l1f024.c | 3 ++- lib/stm32/f0/Makefile | 2 +- lib/stm32/f0/rtc.c | 31 ----------------------- lib/stm32/f1/rtc.c | 4 +-- lib/stm32/f2/rtc.c | 31 ----------------------- lib/stm32/f3/rtc.c | 38 ---------------------------- lib/stm32/f4/rtc.c | 7 +++-- lib/stm32/l1/rtc.c | 31 ----------------------- 8 files changed, 10 insertions(+), 137 deletions(-) delete mode 100644 lib/stm32/f0/rtc.c delete mode 100644 lib/stm32/f2/rtc.c delete mode 100644 lib/stm32/f3/rtc.c delete mode 100644 lib/stm32/l1/rtc.c diff --git a/lib/stm32/common/rtc_common_l1f024.c b/lib/stm32/common/rtc_common_l1f024.c index 7579dfdc..2d529449 100644 --- a/lib/stm32/common/rtc_common_l1f024.c +++ b/lib/stm32/common/rtc_common_l1f024.c @@ -1,4 +1,5 @@ -/** @addtogroup rtc_file +/** @addtogroup rtc_file RTC peripheral API +@ingroup peripheral_apis @author @htmlonly © @endhtmlonly 2012 Karl Palsson diff --git a/lib/stm32/f0/Makefile b/lib/stm32/f0/Makefile index 326baac0..efe25563 100644 --- a/lib/stm32/f0/Makefile +++ b/lib/stm32/f0/Makefile @@ -36,7 +36,7 @@ TGT_CFLAGS += $(STANDARD_FLAGS) ARFLAGS = rcs -OBJS = can.o flash.o rcc.o rtc.o comparator.o \ +OBJS = can.o flash.o rcc.o comparator.o \ adc.o desig.o OBJS += gpio_common_all.o gpio_common_f0234.o crc_common_all.o crc_v2.o \ diff --git a/lib/stm32/f0/rtc.c b/lib/stm32/f0/rtc.c deleted file mode 100644 index 6d55cc71..00000000 --- a/lib/stm32/f0/rtc.c +++ /dev/null @@ -1,31 +0,0 @@ -/** @defgroup rtc_file RTC - * - * @ingroup STM32F0xx - * - * @brief libopencm3 STM32F0xx RTC - * - * @version 1.0.0 - * - * @date 10 July 2013 - * - * LGPL License Terms @ref lgpl_license - */ - -/* - * This file is part of the libopencm3 project. - * - * This library is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library. If not, see . - */ - -#include diff --git a/lib/stm32/f1/rtc.c b/lib/stm32/f1/rtc.c index 2743eed9..e32424f4 100644 --- a/lib/stm32/f1/rtc.c +++ b/lib/stm32/f1/rtc.c @@ -1,6 +1,6 @@ -/** @defgroup rtc_file RTC +/** @defgroup rtc_file RTC peripheral API * - * @ingroup STM32F1xx + * @ingroup peripheral_apis * * @brief libopencm3 STM32F1xx RTC * diff --git a/lib/stm32/f2/rtc.c b/lib/stm32/f2/rtc.c deleted file mode 100644 index 06666ab1..00000000 --- a/lib/stm32/f2/rtc.c +++ /dev/null @@ -1,31 +0,0 @@ -/** @defgroup rtc_file RTC - * - * @ingroup STM32F2xx - * - * @brief libopencm3 STM32F2xx RTC - * - * @version 1.0.0 - * - * @date 4 March 2013 - * - * LGPL License Terms @ref lgpl_license - */ - -/* - * This file is part of the libopencm3 project. - * - * This library is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library. If not, see . - */ - -#include diff --git a/lib/stm32/f3/rtc.c b/lib/stm32/f3/rtc.c deleted file mode 100644 index f332765a..00000000 --- a/lib/stm32/f3/rtc.c +++ /dev/null @@ -1,38 +0,0 @@ -/** @defgroup rtc_file RTC - * - * @ingroup STM32F3xx - * - * @brief libopencm3 STM32F3xx Real Time Clock - * - * @version 1.0.0 - * - * @author @htmlonly © @endhtmlonly 2014 - * Ken Sarkies - * - * @date 13 January 2014 - * - * LGPL License Terms @ref lgpl_license - */ - -/* - * This file is part of the libopencm3 project. - * - * Copyright (C) 2014 Ken Sarkies - * - * This library is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library. If not, see . - */ - -#include - - diff --git a/lib/stm32/f4/rtc.c b/lib/stm32/f4/rtc.c index f08ac2bc..4d1008c1 100644 --- a/lib/stm32/f4/rtc.c +++ b/lib/stm32/f4/rtc.c @@ -1,6 +1,6 @@ -/** @defgroup rtc_file RTC +/** @defgroup rtc_file * - * @ingroup STM32F4xx + * @ingroup peripheral_apis * * @brief libopencm3 STM32F4xx RTC * @@ -32,6 +32,7 @@ #include #include +/**@{*/ /*---------------------------------------------------------------------------*/ /** @brief Enable the wakeup timer @@ -95,3 +96,5 @@ void rtc_disable_wakeup_timer_interrupt(void) /* 3. Disable RTC wakeup timer event. */ RTC_CR &= ~RTC_CR_WUTIE; } + +/**@}*/ \ No newline at end of file diff --git a/lib/stm32/l1/rtc.c b/lib/stm32/l1/rtc.c deleted file mode 100644 index 5628aa7e..00000000 --- a/lib/stm32/l1/rtc.c +++ /dev/null @@ -1,31 +0,0 @@ -/** @defgroup rtc_file RTC - * - * @ingroup STM32L1xx - * - * @brief libopencm3 STM32L1xx RTC - * - * @version 1.0.0 - * - * @date 4 March 2013 - * - * LGPL License Terms @ref lgpl_license - */ - -/* - * This file is part of the libopencm3 project. - * - * This library is free software: you can redistribute it and/or modify - * it under the terms of the GNU Lesser General Public License as published by - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This library is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU Lesser General Public License for more details. - * - * You should have received a copy of the GNU Lesser General Public License - * along with this library. If not, see . - */ - -#include