mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

TARGET_MAX32625NEXPAQ/TOOLCHAIN_IAR/flc.h@172:65be27845400, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 20:53:29 2019 +0000
Revision:
172:65be27845400
Parent:
171:3a7713b1edbc 
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Anna Bridge 169:a7c7b631e539 1 /**
Anna Bridge 169:a7c7b631e539 2 * @file flc.h
Anna Bridge 169:a7c7b631e539 3 * @brief Flash Controller function prototypes and data types.
Anna Bridge 169:a7c7b631e539 4 */
Anna Bridge 169:a7c7b631e539 5
Anna Bridge 169:a7c7b631e539 6 /* ****************************************************************************
Anna Bridge 169:a7c7b631e539 7 * Copyright (C) 2016 Maxim Integrated Products, Inc., All Rights Reserved.
Anna Bridge 169:a7c7b631e539 8 *
Anna Bridge 169:a7c7b631e539 9 * Permission is hereby granted, free of charge, to any person obtaining a
Anna Bridge 169:a7c7b631e539 10 * copy of this software and associated documentation files (the "Software"),
Anna Bridge 169:a7c7b631e539 11 * to deal in the Software without restriction, including without limitation
Anna Bridge 169:a7c7b631e539 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
Anna Bridge 169:a7c7b631e539 13 * and/or sell copies of the Software, and to permit persons to whom the
Anna Bridge 169:a7c7b631e539 14 * Software is furnished to do so, subject to the following conditions:
Anna Bridge 169:a7c7b631e539 15 *
Anna Bridge 169:a7c7b631e539 16 * The above copyright notice and this permission notice shall be included
Anna Bridge 169:a7c7b631e539 17 * in all copies or substantial portions of the Software.
Anna Bridge 169:a7c7b631e539 18 *
Anna Bridge 169:a7c7b631e539 19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
Anna Bridge 169:a7c7b631e539 20 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Anna Bridge 169:a7c7b631e539 21 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Anna Bridge 169:a7c7b631e539 22 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
Anna Bridge 169:a7c7b631e539 23 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Anna Bridge 169:a7c7b631e539 24 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Anna Bridge 169:a7c7b631e539 25 * OTHER DEALINGS IN THE SOFTWARE.
Anna Bridge 169:a7c7b631e539 26 *
Anna Bridge 169:a7c7b631e539 27 * Except as contained in this notice, the name of Maxim Integrated
Anna Bridge 169:a7c7b631e539 28 * Products, Inc. shall not be used except as stated in the Maxim Integrated
Anna Bridge 169:a7c7b631e539 29 * Products, Inc. Branding Policy.
Anna Bridge 169:a7c7b631e539 30 *
Anna Bridge 169:a7c7b631e539 31 * The mere transfer of this software does not imply any licenses
Anna Bridge 169:a7c7b631e539 32 * of trade secrets, proprietary technology, copyrights, patents,
Anna Bridge 169:a7c7b631e539 33 * trademarks, maskwork rights, or any other form of intellectual
Anna Bridge 169:a7c7b631e539 34 * property whatsoever. Maxim Integrated Products, Inc. retains all
Anna Bridge 169:a7c7b631e539 35 * ownership rights.
Anna Bridge 169:a7c7b631e539 36 *
Anna Bridge 169:a7c7b631e539 37 * $Date: 2016-08-02 13:46:43 -0500 (Tue, 02 Aug 2016) $
Anna Bridge 169:a7c7b631e539 38 * $Revision: 23898 $
Anna Bridge 169:a7c7b631e539 39 *
Anna Bridge 169:a7c7b631e539 40 *************************************************************************** */
Anna Bridge 169:a7c7b631e539 41
Anna Bridge 169:a7c7b631e539 42 /* Define to prevent redundant inclusion */
Anna Bridge 169:a7c7b631e539 43 #ifndef _FLC_H_
Anna Bridge 169:a7c7b631e539 44 #define _FLC_H_
Anna Bridge 169:a7c7b631e539 45
Anna Bridge 169:a7c7b631e539 46 /* **** Includes **** */
Anna Bridge 169:a7c7b631e539 47 #include "flc_regs.h"
Anna Bridge 169:a7c7b631e539 48
Anna Bridge 169:a7c7b631e539 49 #ifdef __cplusplus
Anna Bridge 169:a7c7b631e539 50 extern "C" {
Anna Bridge 169:a7c7b631e539 51 #endif
Anna Bridge 169:a7c7b631e539 52
Anna Bridge 169:a7c7b631e539 53 /**
Anna Bridge 169:a7c7b631e539 54 * @defgroup flc Flash Controller
Anna Bridge 169:a7c7b631e539 55 * @ingroup sysconfig
Anna Bridge 169:a7c7b631e539 56 * @{
Anna Bridge 169:a7c7b631e539 57 */
Anna Bridge 169:a7c7b631e539 58
Anna Bridge 169:a7c7b631e539 59 /* **** Definitions **** */
Anna Bridge 169:a7c7b631e539 60
Anna Bridge 169:a7c7b631e539 61 /* **** Globals **** */
Anna Bridge 169:a7c7b631e539 62
Anna Bridge 169:a7c7b631e539 63 /* **** Function Prototypes **** */
Anna Bridge 169:a7c7b631e539 64
Anna Bridge 169:a7c7b631e539 65 /**
Anna Bridge 169:a7c7b631e539 66 * @brief Prepares the Flash Controller for in-application flash operations. This function
Anna Bridge 169:a7c7b631e539 67 * only needs to be called one time after a reset event.
Anna Bridge 169:a7c7b631e539 68 *
Anna Bridge 169:a7c7b631e539 69 * @return #E_NO_ERROR if flash controller initialized correctly, error if
Anna Bridge 169:a7c7b631e539 70 * unsuccessful.
Anna Bridge 169:a7c7b631e539 71 */
Anna Bridge 169:a7c7b631e539 72 int FLC_Init(void);
Anna Bridge 169:a7c7b631e539 73
Anna Bridge 169:a7c7b631e539 74 /**
Anna Bridge 169:a7c7b631e539 75 * @brief This function will erase a single page of flash.
Anna Bridge 169:a7c7b631e539 76 *
Anna Bridge 169:a7c7b631e539 77 * @param address Address of the page to be erased.
Anna Bridge 169:a7c7b631e539 78 * @param erase_code Flash erase code; defined as
Anna Bridge 169:a7c7b631e539 79 * #MXC_V_FLC_ERASE_CODE_PAGE_ERASE for page erase
Anna Bridge 169:a7c7b631e539 80 * @param unlock_key Unlock key, #MXC_V_FLC_FLSH_UNLOCK_KEY.
Anna Bridge 169:a7c7b631e539 81 *
Anna Bridge 169:a7c7b631e539 82 * @returns #E_NO_ERROR if page erase successful, error if unsuccessful.
Anna Bridge 169:a7c7b631e539 83 */
Anna Bridge 169:a7c7b631e539 84 int FLC_PageErase(uint32_t address, uint8_t erase_code, uint8_t unlock_key);
Anna Bridge 169:a7c7b631e539 85
Anna Bridge 169:a7c7b631e539 86 /**
Anna Bridge 169:a7c7b631e539 87 * @brief This function writes data to the flash device through the flash
Anna Bridge 169:a7c7b631e539 88 * controller interface
Anna Bridge 169:a7c7b631e539 89 *
Anna Bridge 169:a7c7b631e539 90 * @param address Start address for desired write. @note This address
Anna Bridge 169:a7c7b631e539 91 * must be 32-bit word aligned
Anna Bridge 169:a7c7b631e539 92 * @param data A pointer to the buffer containing the data to write.
Anna Bridge 169:a7c7b631e539 93 * @param length Size of the data to write in bytes. @note The length
Anna Bridge 169:a7c7b631e539 94 * must be in 32-bit multiples.
Anna Bridge 169:a7c7b631e539 95 * @param unlock_key Unlock key, #MXC_V_FLC_FLSH_UNLOCK_KEY.
Anna Bridge 169:a7c7b631e539 96 *
Anna Bridge 169:a7c7b631e539 97 * @returns #E_NO_ERROR if data written successfully, error if unsuccessful.
Anna Bridge 169:a7c7b631e539 98 */
Anna Bridge 169:a7c7b631e539 99 int FLC_Write(uint32_t address, const void *data, uint32_t length, uint8_t unlock_key);
Anna Bridge 169:a7c7b631e539 100
Anna Bridge 169:a7c7b631e539 101 /**
Anna Bridge 169:a7c7b631e539 102 * @brief This function will mass erase the flash.
Anna Bridge 169:a7c7b631e539 103 *
Anna Bridge 169:a7c7b631e539 104 * @param erase_code Flash erase code, #MXC_V_FLC_ERASE_CODE_MASS_ERASE.
Anna Bridge 169:a7c7b631e539 105 * @param unlock_key Unlock key, #MXC_V_FLC_FLSH_UNLOCK_KEY.
Anna Bridge 169:a7c7b631e539 106 *
Anna Bridge 169:a7c7b631e539 107 * @returns #E_NO_ERROR if device mass erase successful, error if unsuccessful.
Anna Bridge 169:a7c7b631e539 108 */
Anna Bridge 169:a7c7b631e539 109 int FLC_MassErase(uint8_t erase_code, uint8_t unlock_key);
Anna Bridge 169:a7c7b631e539 110
Anna Bridge 169:a7c7b631e539 111 /**@} end of group flc */
Anna Bridge 169:a7c7b631e539 112
Anna Bridge 169:a7c7b631e539 113 #ifdef __cplusplus
Anna Bridge 169:a7c7b631e539 114 }
Anna Bridge 169:a7c7b631e539 115 #endif
Anna Bridge 169:a7c7b631e539 116
Anna Bridge 169:a7c7b631e539 117 #endif /* _FLC_H_ */