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

Documentation added to flash modules for all STM32 families.

Browse Source
This commit is contained in:
Ken Sarkies
2014-01-16 05:49:57 +10:30
committed by Frantisek Burian
parent e4f4845e0c
commit a54a12e1c9
16 changed files with 847 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
include/libopencm3/stm32/common/flash_common_f234.h
View File

@@ -1,3 +1,11 @@
/** @addtogroup flash_defines
*
* @author @htmlonly © @endhtmlonly 2010
* Thomas Otto <tommi@viadmin.org>
* @author @htmlonly &copy; @endhtmlonly 2010
* Mark Butler <mbutler@physics.otago.ac.nz>
*
*/
/*
* This file is part of the libopencm3 project.
*
@@ -30,6 +38,7 @@
/** @endcond */
#ifndef LIBOPENCM3_FLASH_COMMON_F234_H
#define LIBOPENCM3_FLASH_COMMON_F234_H
/**@{*/
#include <libopencm3/cm3/common.h>
@@ -75,6 +84,7 @@ void flash_clear_status_flags(void);
void flash_wait_for_last_operation(void);
END_DECLS
/**@}*/
#endif
/** @cond */

10
include/libopencm3/stm32/common/flash_common_f24.h
View File

@@ -1,3 +1,11 @@
/** @addtogroup flash_defines
*
* @author @htmlonly &copy; @endhtmlonly 2010
* Thomas Otto <tommi@viadmin.org>
* @author @htmlonly &copy; @endhtmlonly 2010
* Mark Butler <mbutler@physics.otago.ac.nz>
*
*/
/*
* This file is part of the libopencm3 project.
*
@@ -30,6 +38,7 @@
/** @endcond */
#ifndef LIBOPENCM3_FLASH_COMMON_F24_H
#define LIBOPENCM3_FLASH_COMMON_F24_H
/**@{*/
#include <libopencm3/cm3/common.h>
#include <libopencm3/stm32/common/flash_common_f234.h>
@@ -128,6 +137,7 @@ void flash_program(uint32_t address, uint8_t *data, uint32_t len);
void flash_program_option_bytes(uint32_t data);
END_DECLS
/**@}*/
#endif
/** @cond */

7
include/libopencm3/stm32/f0/flash.h
View File

@@ -6,7 +6,10 @@
*
* @version 1.0.0
*
* @date 11 July 2013
* @author @htmlonly &copy; @endhtmlonly 2013
* Frantisek Burian <BuFran@seznam.cz>
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
@@ -31,6 +34,7 @@
#ifndef LIBOPENCM3_FLASH_H
#define LIBOPENCM3_FLASH_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@@ -137,5 +141,6 @@ void flash_erase_page(uint32_t page_address);
void flash_erase_all_pages(void);
END_DECLS
/**@}*/
#endif

25
include/libopencm3/stm32/f1/flash.h
View File

@@ -1,3 +1,16 @@
/** @defgroup flash_defines FLASH Defines
*
* @ingroup STM32F1xx_defines
*
* @brief Defined Constants and Types for the STM32F1xx FLASH Memory
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -28,6 +41,8 @@
#ifndef LIBOPENCM3_FLASH_H
#define LIBOPENCM3_FLASH_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@@ -76,14 +91,14 @@
/* FLASH_OBR[25:18]: Data1 */
/* FLASH_OBR[17:10]: Data0 */
#define FLASH_OBR_NRST_STDBY (1 << 4)
#define FLASH_OBR_NRST_STOP (1 << 3)
#define FLASH_OBR_WDG_SW (1 << 2)
#define FLASH_OBR_NRST_STOP (1 << 3)
#define FLASH_OBR_WDG_SW (1 << 2)
#define FLASH_OBR_RDPRT (1 << 1)
#define FLASH_OBR_OPTERR (1 << 0)
#define FLASH_OBR_OPTERR (1 << 0)
/* --- FLASH Keys -----------------------------------------------------------*/
#define FLASH_RDP_KEY ((uint16_t)0x00a5)
#define FLASH_RDP_KEY ((uint16_t)0x00a5)
#define FLASH_KEYR_KEY1 ((uint32_t)0x45670123)
#define FLASH_KEYR_KEY2 ((uint32_t)0xcdef89ab)
@@ -115,4 +130,6 @@ void flash_program_option_bytes(uint32_t address, uint16_t data);
END_DECLS
/**@}*/
#endif

13
include/libopencm3/stm32/f2/flash.h
View File

@@ -1,3 +1,16 @@
/** @defgroup flash_defines FLASH Defines
*
* @ingroup STM32F2xx_defines
*
* @brief Defined Constants and Types for the STM32F2xx FLASH Memory
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

2
include/libopencm3/stm32/f3/flash.h
View File

@@ -30,6 +30,7 @@
#ifndef LIBOPENCM3_FLASH_H
#define LIBOPENCM3_FLASH_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/stm32/common/flash_common_f234.h>
@@ -67,6 +68,7 @@
#define FLASH_CR_MER (1 << 2)
#define FLASH_CR_PER (1 << 1)
#define FLASH_CR_PG (1 << 0)
/**@}*/
#endif

13
include/libopencm3/stm32/f4/flash.h
View File

@@ -1,3 +1,16 @@
/** @defgroup flash_defines FLASH Defines
*
* @ingroup STM32F4xx_defines
*
* @brief Defined Constants and Types for the STM32F4xx FLASH Memory
*
* @version 1.0.0
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*

18
include/libopencm3/stm32/l1/flash.h
View File

@@ -1,3 +1,19 @@
/** @defgroup flash_defines FLASH Defines
*
* @ingroup STM32L1xx_defines
*
* @brief Defined Constants and Types for the STM32L1xx FLASH Memory
*
* @version 1.0.0
*
* @author @htmlonly &copy; @endhtmlonly 2012
* Karl Palsson <karlp@tweak.net.au>
*
* @date 14 January 2014
*
* LGPL License Terms @ref lgpl_license
*/
/*
* This file is part of the libopencm3 project.
*
@@ -26,6 +42,7 @@
#ifndef LIBOPENCM3_FLASH_H
#define LIBOPENCM3_FLASH_H
/**@{*/
#include <libopencm3/stm32/memorymap.h>
#include <libopencm3/cm3/common.h>
@@ -122,5 +139,6 @@ void flash_prefetch_disable(void);
void flash_set_ws(uint32_t ws);
END_DECLS
/**@}*/
#endif