mbed official / mbed-dev

mbed library sources. Supersedes mbed-src.

Dependents:   Nucleo_Hello_Encoder BLE_iBeaconScan AM1805_DEMO DISCO-F429ZI_ExportTemplate1 ... more

targets/TARGET_Maxim/TARGET_MAX32620C/flash_api.c@189:f392fc9709a3, 2019-02-20 (annotated)

Committer:
AnnaBridge
Date:
Wed Feb 20 22:31:08 2019 +0000
Revision:
189:f392fc9709a3
mbed library release version 165

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 189:f392fc9709a3 1 /*******************************************************************************
AnnaBridge 189:f392fc9709a3 2 * Copyright (C) 2018 Maxim Integrated Products, Inc., All Rights Reserved.
AnnaBridge 189:f392fc9709a3 3 *
AnnaBridge 189:f392fc9709a3 4 * Permission is hereby granted, free of charge, to any person obtaining a
AnnaBridge 189:f392fc9709a3 5 * copy of this software and associated documentation files (the "Software"),
AnnaBridge 189:f392fc9709a3 6 * to deal in the Software without restriction, including without limitation
AnnaBridge 189:f392fc9709a3 7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
AnnaBridge 189:f392fc9709a3 8 * and/or sell copies of the Software, and to permit persons to whom the
AnnaBridge 189:f392fc9709a3 9 * Software is furnished to do so, subject to the following conditions:
AnnaBridge 189:f392fc9709a3 10 *
AnnaBridge 189:f392fc9709a3 11 * The above copyright notice and this permission notice shall be included
AnnaBridge 189:f392fc9709a3 12 * in all copies or substantial portions of the Software.
AnnaBridge 189:f392fc9709a3 13 *
AnnaBridge 189:f392fc9709a3 14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
AnnaBridge 189:f392fc9709a3 15 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
AnnaBridge 189:f392fc9709a3 16 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
AnnaBridge 189:f392fc9709a3 17 * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES
AnnaBridge 189:f392fc9709a3 18 * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
AnnaBridge 189:f392fc9709a3 19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
AnnaBridge 189:f392fc9709a3 20 * OTHER DEALINGS IN THE SOFTWARE.
AnnaBridge 189:f392fc9709a3 21 *
AnnaBridge 189:f392fc9709a3 22 * Except as contained in this notice, the name of Maxim Integrated
AnnaBridge 189:f392fc9709a3 23 * Products, Inc. shall not be used except as stated in the Maxim Integrated
AnnaBridge 189:f392fc9709a3 24 * Products, Inc. Branding Policy.
AnnaBridge 189:f392fc9709a3 25 *
AnnaBridge 189:f392fc9709a3 26 * The mere transfer of this software does not imply any licenses
AnnaBridge 189:f392fc9709a3 27 * of trade secrets, proprietary technology, copyrights, patents,
AnnaBridge 189:f392fc9709a3 28 * trademarks, maskwork rights, or any other form of intellectual
AnnaBridge 189:f392fc9709a3 29 * property whatsoever. Maxim Integrated Products, Inc. retains all
AnnaBridge 189:f392fc9709a3 30 * ownership rights.
AnnaBridge 189:f392fc9709a3 31 *******************************************************************************
AnnaBridge 189:f392fc9709a3 32 */
AnnaBridge 189:f392fc9709a3 33
AnnaBridge 189:f392fc9709a3 34 #if DEVICE_FLASH
AnnaBridge 189:f392fc9709a3 35 #include "flash_api.h"
AnnaBridge 189:f392fc9709a3 36 #include "mbed_critical.h"
AnnaBridge 189:f392fc9709a3 37 #include "cmsis.h"
AnnaBridge 189:f392fc9709a3 38 #include "flc.h"
AnnaBridge 189:f392fc9709a3 39
AnnaBridge 189:f392fc9709a3 40
AnnaBridge 189:f392fc9709a3 41 /**
AnnaBridge 189:f392fc9709a3 42 * * \defgroup flash_hal Flash HAL API
AnnaBridge 189:f392fc9709a3 43 * * @{
AnnaBridge 189:f392fc9709a3 44 * */
AnnaBridge 189:f392fc9709a3 45
AnnaBridge 189:f392fc9709a3 46 /** Initialize the flash peripheral and the flash_t object
AnnaBridge 189:f392fc9709a3 47 * *
AnnaBridge 189:f392fc9709a3 48 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 49 * * @return 0 for success, -1 for error
AnnaBridge 189:f392fc9709a3 50 * */
AnnaBridge 189:f392fc9709a3 51 int32_t flash_init(flash_t *obj)
AnnaBridge 189:f392fc9709a3 52 {
AnnaBridge 189:f392fc9709a3 53 return FLC_Init();
AnnaBridge 189:f392fc9709a3 54 }
AnnaBridge 189:f392fc9709a3 55
AnnaBridge 189:f392fc9709a3 56 /** Uninitialize the flash peripheral and the flash_t object
AnnaBridge 189:f392fc9709a3 57 * *
AnnaBridge 189:f392fc9709a3 58 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 59 * * @return 0 for success, -1 for error
AnnaBridge 189:f392fc9709a3 60 * */
AnnaBridge 189:f392fc9709a3 61 int32_t flash_free(flash_t *obj)
AnnaBridge 189:f392fc9709a3 62 {
AnnaBridge 189:f392fc9709a3 63 return 0;
AnnaBridge 189:f392fc9709a3 64 }
AnnaBridge 189:f392fc9709a3 65
AnnaBridge 189:f392fc9709a3 66 /** Erase one sector starting at defined address
AnnaBridge 189:f392fc9709a3 67 * *
AnnaBridge 189:f392fc9709a3 68 * * The address should be at sector boundary. This function does not do any check for address alignments
AnnaBridge 189:f392fc9709a3 69 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 70 * * @param address The sector starting address
AnnaBridge 189:f392fc9709a3 71 * * @return 0 for success, -1 for error
AnnaBridge 189:f392fc9709a3 72 * */
AnnaBridge 189:f392fc9709a3 73 int32_t flash_erase_sector(flash_t *obj, uint32_t address)
AnnaBridge 189:f392fc9709a3 74 {
AnnaBridge 189:f392fc9709a3 75 if(FLC_PageErase(address, MXC_V_FLC_ERASE_CODE_PAGE_ERASE, MXC_V_FLC_FLSH_UNLOCK_KEY) != 0)
AnnaBridge 189:f392fc9709a3 76 {
AnnaBridge 189:f392fc9709a3 77 return -1;
AnnaBridge 189:f392fc9709a3 78 } else {
AnnaBridge 189:f392fc9709a3 79 return 0;
AnnaBridge 189:f392fc9709a3 80 }
AnnaBridge 189:f392fc9709a3 81
AnnaBridge 189:f392fc9709a3 82 }
AnnaBridge 189:f392fc9709a3 83
AnnaBridge 189:f392fc9709a3 84 /** Program pages starting at defined address
AnnaBridge 189:f392fc9709a3 85 * *
AnnaBridge 189:f392fc9709a3 86 * * The pages should not cross multiple sectors.
AnnaBridge 189:f392fc9709a3 87 * * This function does not do any check for address alignments or if size is aligned to a page size.
AnnaBridge 189:f392fc9709a3 88 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 89 * * @param address The sector starting address
AnnaBridge 189:f392fc9709a3 90 * * @param data The data buffer to be programmed
AnnaBridge 189:f392fc9709a3 91 * * @param size The number of bytes to program
AnnaBridge 189:f392fc9709a3 92 * * @return 0 for success, -1 for error
AnnaBridge 189:f392fc9709a3 93 * */
AnnaBridge 189:f392fc9709a3 94 int32_t flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data, uint32_t size)
AnnaBridge 189:f392fc9709a3 95 {
AnnaBridge 189:f392fc9709a3 96 int32_t status = E_BUSY;
AnnaBridge 189:f392fc9709a3 97
AnnaBridge 189:f392fc9709a3 98 while ( status == E_BUSY )
AnnaBridge 189:f392fc9709a3 99 {
AnnaBridge 189:f392fc9709a3 100 status = FLC_Write(address, data, size, MXC_V_FLC_FLSH_UNLOCK_KEY);
AnnaBridge 189:f392fc9709a3 101 }
AnnaBridge 189:f392fc9709a3 102
AnnaBridge 189:f392fc9709a3 103 if (status != 0)
AnnaBridge 189:f392fc9709a3 104 {
AnnaBridge 189:f392fc9709a3 105 return -1;
AnnaBridge 189:f392fc9709a3 106 } else {
AnnaBridge 189:f392fc9709a3 107 return 0;
AnnaBridge 189:f392fc9709a3 108 }
AnnaBridge 189:f392fc9709a3 109
AnnaBridge 189:f392fc9709a3 110 }
AnnaBridge 189:f392fc9709a3 111
AnnaBridge 189:f392fc9709a3 112 /** Get sector size
AnnaBridge 189:f392fc9709a3 113 * *
AnnaBridge 189:f392fc9709a3 114 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 115 * * @param address The sector starting address
AnnaBridge 189:f392fc9709a3 116 * * @return The size of a sector
AnnaBridge 189:f392fc9709a3 117 * */
AnnaBridge 189:f392fc9709a3 118 uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address)
AnnaBridge 189:f392fc9709a3 119 {
AnnaBridge 189:f392fc9709a3 120 /* 1 sector = 1 page */
AnnaBridge 189:f392fc9709a3 121 if (address >= (MXC_FLASH_MEM_BASE + MXC_FLASH_FULL_MEM_SIZE)) {
AnnaBridge 189:f392fc9709a3 122 return MBED_FLASH_INVALID_SIZE;
AnnaBridge 189:f392fc9709a3 123 } else {
AnnaBridge 189:f392fc9709a3 124 return MXC_FLASH_PAGE_SIZE;
AnnaBridge 189:f392fc9709a3 125 }
AnnaBridge 189:f392fc9709a3 126 }
AnnaBridge 189:f392fc9709a3 127
AnnaBridge 189:f392fc9709a3 128 /** Get page size
AnnaBridge 189:f392fc9709a3 129 * *
AnnaBridge 189:f392fc9709a3 130 * * The page size defines the writable page size
AnnaBridge 189:f392fc9709a3 131 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 132 * * @return The size of a page
AnnaBridge 189:f392fc9709a3 133 * */
AnnaBridge 189:f392fc9709a3 134 uint32_t flash_get_page_size(const flash_t *obj)
AnnaBridge 189:f392fc9709a3 135 {
AnnaBridge 189:f392fc9709a3 136 return MXC_FLASH_PAGE_SIZE;
AnnaBridge 189:f392fc9709a3 137 }
AnnaBridge 189:f392fc9709a3 138
AnnaBridge 189:f392fc9709a3 139 /** Get start address for the flash region
AnnaBridge 189:f392fc9709a3 140 * *
AnnaBridge 189:f392fc9709a3 141 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 142 * * @return The start address for the flash region
AnnaBridge 189:f392fc9709a3 143 * */
AnnaBridge 189:f392fc9709a3 144 uint32_t flash_get_start_address(const flash_t *obj)
AnnaBridge 189:f392fc9709a3 145 {
AnnaBridge 189:f392fc9709a3 146 return MXC_FLASH_MEM_BASE;
AnnaBridge 189:f392fc9709a3 147 }
AnnaBridge 189:f392fc9709a3 148
AnnaBridge 189:f392fc9709a3 149 /** Get the flash region size
AnnaBridge 189:f392fc9709a3 150 * *
AnnaBridge 189:f392fc9709a3 151 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 152 * * @return The flash region size
AnnaBridge 189:f392fc9709a3 153 * */
AnnaBridge 189:f392fc9709a3 154 uint32_t flash_get_size(const flash_t *obj)
AnnaBridge 189:f392fc9709a3 155 {
AnnaBridge 189:f392fc9709a3 156 return MXC_FLASH_FULL_MEM_SIZE;
AnnaBridge 189:f392fc9709a3 157 }
AnnaBridge 189:f392fc9709a3 158
AnnaBridge 189:f392fc9709a3 159 /** Get the flash erase value
AnnaBridge 189:f392fc9709a3 160 * *
AnnaBridge 189:f392fc9709a3 161 * * @param obj The flash object
AnnaBridge 189:f392fc9709a3 162 * * @return The flash erase value
AnnaBridge 189:f392fc9709a3 163 * */
AnnaBridge 189:f392fc9709a3 164 uint8_t flash_get_erase_value(const flash_t *obj)
AnnaBridge 189:f392fc9709a3 165 {
AnnaBridge 189:f392fc9709a3 166 (void)obj;
AnnaBridge 189:f392fc9709a3 167
AnnaBridge 189:f392fc9709a3 168 return 0xFF;
AnnaBridge 189:f392fc9709a3 169 }
AnnaBridge 189:f392fc9709a3 170
AnnaBridge 189:f392fc9709a3 171 #endif
AnnaBridge 189:f392fc9709a3 172