Umar Naeem / mbed-dev

mbed library sources. Supersedes mbed-src.

Fork of mbed-dev by Umar Naeem

targets/TARGET_Maxim/TARGET_MAX32625/mxc/flc.h@165:2dd56e6daeec, 2017-05-23 (annotated)

Committer:
ranaumarnaeem
Date:
Tue May 23 12:54:50 2017 +0000
Revision:
165:2dd56e6daeec
Parent:
150:02e0a0aed4ec 
jhjg

Who changed what in which revision?

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