mcu
/
libopencm3
mirror of https://github.com/libopencm3/libopencm3.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

stm32: doc: pwr: move to peripheral_api 

Some families had partially moved to peripheral api, and others were
only documenting common code, but not specific code.  Delete dummy .c
files, and check that all specific apis are also being documented, not
just common apis.
pull/1053/head
Karl Palsson 6 years ago
parent
c557ef96f9
commit
0aef9c2ec6
13 changed files with 24 additions and 171 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      include/libopencm3/stm32/f7/pwr.h
  2. 3
      lib/stm32/common/pwr_common_v1.c
  3. 3
      lib/stm32/common/pwr_common_v2.c
  4. 2
      lib/stm32/f0/Makefile
  5. 38
      lib/stm32/f0/pwr.c
  6. 43
      lib/stm32/f1/pwr.c
  7. 39
      lib/stm32/f2/pwr.c
  8. 2
      lib/stm32/f3/Makefile
  9. 40
      lib/stm32/f3/pwr.c
  10. 8
      lib/stm32/f4/pwr.c
  11. 8
      lib/stm32/f7/pwr.c
  12. 3
      lib/stm32/g0/pwr.c
  13. 4
      lib/stm32/l4/pwr.c

2
include/libopencm3/stm32/f7/pwr.h
View File

@ -292,4 +292,6 @@ void pwr_disable_overdrive(void);
END_DECLS END_DECLS
/**@}*/
#endif #endif

3
lib/stm32/common/pwr_common_v1.c
View File

@ -1,4 +1,5 @@
/** @addtogroup pwr_file /** @addtogroup pwr_file PWR peripheral API
@ingroup peripheral_apis
@author @htmlonly © @endhtmlonly 2012 @author @htmlonly © @endhtmlonly 2012
Ken Sarkies <ksarkies@internode.on.net> Ken Sarkies <ksarkies@internode.on.net>

3
lib/stm32/common/pwr_common_v2.c
View File

@ -1,4 +1,5 @@
/** @addtogroup pwr_file /** @addtogroup pwr_file PWR peripheral API
* @ingroup peripheral_apis
* *
* @author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au> * @author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
*/ */

2
lib/stm32/f0/Makefile
View File

@ -37,7 +37,7 @@ TGT_CFLAGS += $(STANDARD_FLAGS)
ARFLAGS = rcs ARFLAGS = rcs
OBJS = can.o flash.o rcc.o rtc.o comparator.o \ OBJS = can.o flash.o rcc.o rtc.o comparator.o \
pwr.o adc.o desig.o adc.o desig.o
OBJS += gpio_common_all.o gpio_common_f0234.o crc_common_all.o crc_v2.o \ OBJS += gpio_common_all.o gpio_common_f0234.o crc_common_all.o crc_v2.o \
pwr_common_v1.o iwdg_common_all.o rtc_common_l1f024.o \ pwr_common_v1.o iwdg_common_all.o rtc_common_l1f024.o \

38
lib/stm32/f0/pwr.c
View File

@ -1,38 +0,0 @@
/** @defgroup pwr_file PWR
*
* @ingroup STM32F0xx
*
* @brief <b>libopencm3 STM32F0xx Power Control</b>
*
* @version 1.0.0
*
* @date 11 July 2013
*
* This library supports the power control system for the
* STM32F0 series of ARM Cortex Microcontrollers by ST Microelectronics.
*
* 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 <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/stm32/pwr.h>
/**@}*/

43
lib/stm32/f1/pwr.c
View File

@ -1,43 +0,0 @@
/** @defgroup pwr_file PWR
*
* @ingroup STM32F1xx
*
* @brief <b>libopencm3 STM32F1xx Power Control</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2012
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 18 August 2012
*
* This library supports the power control system for the
* STM32F1 series of ARM Cortex Microcontrollers by ST Microelectronics.
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2012 Ken Sarkies <ksarkies@internode.on.net>
*
* 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 <http://www.gnu.org/licenses/>.
*/
/**@{*/
#include <libopencm3/stm32/pwr.h>
/**@}*/

39
lib/stm32/f2/pwr.c
View File

@ -1,39 +0,0 @@
/** @defgroup pwr_file PWR
*
* @ingroup STM32F2xx
*
* @brief <b>libopencm3 STM32F2xx Power Control</b>
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 13 January 2014
*
* This library supports the power control system for the
* STM32F4 series of ARM Cortex Microcontrollers by ST Microelectronics.
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* 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 <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/pwr.h>

2
lib/stm32/f3/Makefile
View File

@ -37,7 +37,7 @@ TGT_CFLAGS += $(STANDARD_FLAGS)
ARFLAGS = rcs ARFLAGS = rcs
OBJS = rcc.o adc.o can.o pwr.o flash.o desig.o OBJS = rcc.o adc.o can.o flash.o desig.o
OBJS += gpio_common_all.o gpio_common_f0234.o \ OBJS += gpio_common_all.o gpio_common_f0234.o \
dac_common_all.o crc_common_all.o crc_v2.o \ dac_common_all.o crc_common_all.o crc_v2.o \

40
lib/stm32/f3/pwr.c
View File

@ -1,40 +0,0 @@
/** @defgroup pwr_file PWR
*
* @ingroup STM32F3xx
*
* @brief <b>libopencm3 STM32F3xx Power Control</b>
*
* @author @htmlonly &copy; @endhtmlonly 2014
* Ken Sarkies <ksarkies@internode.on.net>
*
* @date 13 January 2014
*
* @version 1.0.0
*
* @date 11 July 2013
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
* Copyright (C) 2014 Ken Sarkies <ksarkies@internode.on.net>
*
* 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 <http://www.gnu.org/licenses/>.
*/
#include <libopencm3/stm32/pwr.h>

8
lib/stm32/f4/pwr.c
View File

@ -1,6 +1,6 @@
/** @defgroup pwr_file PWR /** @defgroup pwr_file
* *
* @ingroup STM32F4xx * @ingroup peripheral_apis
* *
* @brief <b>libopencm3 STM32F4xx Power Control</b> * @brief <b>libopencm3 STM32F4xx Power Control</b>
* *
@ -36,6 +36,8 @@
#include <libopencm3/stm32/pwr.h> #include <libopencm3/stm32/pwr.h>
/**@{*/
void pwr_set_vos_scale(enum pwr_vos_scale scale) void pwr_set_vos_scale(enum pwr_vos_scale scale)
{ {
uint32_t reg32; uint32_t reg32;
@ -43,3 +45,5 @@ void pwr_set_vos_scale(enum pwr_vos_scale scale)
reg32 |= (scale & PWR_CR_VOS_MASK) << PWR_CR_VOS_SHIFT; reg32 |= (scale & PWR_CR_VOS_MASK) << PWR_CR_VOS_SHIFT;
PWR_CR = reg32; PWR_CR = reg32;
} }
/**@}*/

8
lib/stm32/f7/pwr.c
View File

@ -1,6 +1,6 @@
/** @defgroup pwr_file PWR /** @defgroup pwr_file PWR peripheral API
* *
* @ingroup STM32F7xx * @ingroup peripheral_apis
* *
* @brief <b>libopencm3 STM32F7xx Power Control</b> * @brief <b>libopencm3 STM32F7xx Power Control</b>
* *
@ -38,6 +38,8 @@
#include <libopencm3/stm32/pwr.h> #include <libopencm3/stm32/pwr.h>
/**@{*/
void pwr_set_vos_scale(enum pwr_vos_scale scale) void pwr_set_vos_scale(enum pwr_vos_scale scale)
{ {
PWR_CR1 &= ~PWR_CR1_VOS_MASK; PWR_CR1 &= ~PWR_CR1_VOS_MASK;
@ -64,3 +66,5 @@ void pwr_disable_overdrive(void)
PWR_CR1 &= ~(PWR_CR1_ODEN | PWR_CR1_ODSWEN); PWR_CR1 &= ~(PWR_CR1_ODEN | PWR_CR1_ODSWEN);
while (!(PWR_CSR1 & PWR_CSR1_ODSWRDY)); while (!(PWR_CSR1 & PWR_CSR1_ODSWRDY));
} }
/**@}*/

3
lib/stm32/g0/pwr.c
View File

@ -1,4 +1,5 @@
/** @defgroup pwr_file PWR peripheral APIS /** @defgroup pwr_file PWR peripheral API
* @ingroup peripheral_apis
* *
* @author @htmlonly &copy; @endhtmlonly 2019 Guillaume Revaillot <g.revaillot@gmail.com> * @author @htmlonly &copy; @endhtmlonly 2019 Guillaume Revaillot <g.revaillot@gmail.com>
* *

4
lib/stm32/l4/pwr.c
View File

@ -1,6 +1,6 @@
/** @defgroup pwr_file PWR /** @defgroup pwr_file PWR peripheral API
* *
* @ingroup STM32L4xx * @ingroup peripheral_apis
* *
* @brief <b>libopencm3 STM32L4xx Power Control</b> * @brief <b>libopencm3 STM32L4xx Power Control</b>
* *

Write Preview
Loading…
Cancel
Save