EMTime/libopencm3
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Repair to documentation (most documented files)

Browse Source 
to remove errors, duplications and inconsistencies.
File lib/stm32/f1/pwr.c - all code removed as it duplicates that in common/pwr_common.c
Remaining changes do not affect code. Compiles OK.
TODO efm32 has no code so generates no modules
TODO F2 needs pwr.c
TODO L1 needs dma.h and dma.c
This commit is contained in:
Ken Sarkies
2013-03-07 11:14:06 +10:30
parent 31aa3b6f5a
commit e2022f5884
113 changed files with 457 additions and 403 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
lib/stm32/common/crc_common_all.c
View File

@@ -1,13 +1,9 @@
/** @addtogroup crc_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@remake.is>
@date 15 October 2012
*/
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

6
lib/stm32/common/dac_common_all.c
View File

@@ -1,10 +1,6 @@
/** @addtogroup dac_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies
@date 18 August 2012
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
This library supports the Digital to Analog Conversion System in the
STM32F series of ARM Cortex Microcontrollers by ST Microelectronics.

6
lib/stm32/common/dma_common_f13.c
View File

@@ -1,11 +1,7 @@
/** @addtogroup dma_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@date 18 August 2012
This library supports the DMA Control System in the STM32 series of ARM Cortex
Microcontrollers by ST Microelectronics.
@@ -42,7 +38,7 @@ LGPL License Terms @ref lgpl_license
/**@{*/
#include <libopencm3/stm32/f1/dma.h>
#include <libopencm3/stm32/dma.h>
/*-----------------------------------------------------------------------------*/
/** @brief DMA Channel Reset

10
lib/stm32/common/dma_common_f24.c
View File

@@ -1,11 +1,7 @@
/** @addtogroup dma_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 30 November 2012
This library supports the DMA Control System in the STM32F2 and STM32F4
series of ARM Cortex Microcontrollers by ST Microelectronics.
@@ -22,8 +18,8 @@ Each stream has access to a 4 word deep FIFO and can use double buffering
by means of two memory pointers. When using the FIFO it is possible to
configure transfers to occur in indivisible bursts.
It is also possible to select a peripheral to control the flow of data rather
than the DMA controller. This limits the functionality but is udeful when the
It is also possible to select a peripheral instead of the DMA controller to
control the flow of data. This limits the functionality but is useful when the
number of transfers is unknown.
LGPL License Terms @ref lgpl_license
@@ -49,7 +45,7 @@ LGPL License Terms @ref lgpl_license
/**@{*/
#include <libopencm3/stm32/f4/dma.h>
#include <libopencm3/stm32/dma.h>
/*-----------------------------------------------------------------------------*/
/** @brief DMA Stream Reset

6
lib/stm32/common/gpio_common_all.c
View File

@@ -1,4 +1,8 @@
/** @addtogroup gpio_file */
/** @addtogroup gpio_file
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
*/
/*
* This file is part of the libopencm3 project.

5
lib/stm32/common/gpio_common_f24.c
View File

@@ -1,12 +1,8 @@
/** @addtogroup gpio_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 18 August 2012
Each I/O port has 16 individually configurable bits. Many I/O pins share GPIO
functionality with a number of alternate functions and must be configured to the
alternate function mode if these are to be accessed. A feature is available to
@@ -50,7 +46,6 @@ Example 2: Digital input on port C12 with pullup
reg16 = gpio_port_read(GPIOC);
@endcode
LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.

7
lib/stm32/common/i2c_common_all.c
View File

@@ -1,12 +1,8 @@
/** @addtogroup i2c_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2010 Thomas Otto <tommi@viadmin.org>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 15 October 2012
Devices can have up to two I2C peripherals. The peripherals support SMBus and
PMBus variants.
@@ -17,8 +13,7 @@ a multimaster contention is lost or a stop condition is generated.
@todo all sorts of lovely stuff like DMA, Interrupts, SMBus variant, Status
register access, Error conditions
LGPL License Terms @ref lgpl_license
*/
*/
/*
* This file is part of the libopencm3 project.
*

7
lib/stm32/common/iwdg_common_all.c
View File

@@ -1,11 +1,7 @@
/** @addtogroup iwdg_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies ksarkies@internode.on.net
@date 18 August 2012
This library supports the Independent Watchdog Timer System in the STM32F1xx
series of ARM Cortex Microcontrollers by ST Microelectronics.
@@ -20,8 +16,7 @@ relevant bit is not set, the IWDG timer must be enabled by software.
@note: Tested: CPU STM32F103RET6, Board ET-ARM Stamp STM32
LGPL License Terms @ref lgpl_license
*/
*/
/*
* This file is part of the libopencm3 project.
*

14
lib/stm32/common/pwr_common_all.c
View File

@@ -1,19 +1,7 @@
/** @defgroup STM32F1xx-pwr-file PWR
@ingroup STM32F1xx
@brief <b>libopencm3 STM32F1xx Power Control</b>
@version 1.0.0
/** @addtogroup pwr-file PWR
@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.

6
lib/stm32/common/rtc_common_bcd.c
View File

@@ -1,4 +1,8 @@
/** @addtogroup rtc_file */
/** @addtogroup rtc_file
@author @htmlonly &copy; @endhtmlonly 2012 Karl Palsson <karlp@tweak.net.au>
*/
/*
* This file is part of the libopencm3 project.

8
lib/stm32/common/spi_common_all.c
View File

@@ -1,12 +1,8 @@
/** @addtogroup spi_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@author @htmlonly &copy; @endhtmlonly 2012 Ken Sarkies <ksarkies@internode.on.net>
@date 15 October 2012
Devices can have up to three SPI peripherals. The common 4-wire full-duplex
mode of operation is supported, along with 3-wire variants using unidirectional
communication modes or half-duplex bidirectional communication. A variety of
@@ -32,8 +28,8 @@ LSB first.
@todo need additional functions to aid ISRs in retrieving status
LGPL License Terms @ref lgpl_license
*/
*/
/*
* This file is part of the libopencm3 project.
*

8
lib/stm32/common/usart_common_all.c
View File

@@ -1,18 +1,14 @@
/** @addtogroup usart_file
@version 1.0.0
@author @htmlonly &copy; @endhtmlonly 2009 Uwe Hermann <uwe@hermann-uwe.de>
@date 30 August 2012
This library supports the USART/UART in the STM32F series
of ARM Cortex Microcontrollers by ST Microelectronics.
Devices can have up to 3 USARTs and 2 UARTs.
LGPL License Terms @ref lgpl_license
*/
*/
/*
* This file is part of the libopencm3 project.
*