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.

hal/flash_api.h@172:65be27845400, 2019-02-20 (annotated)

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

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 156:ff21514d8981 1 /** \addtogroup hal */
AnnaBridge 156:ff21514d8981 2 /** @{*/
AnnaBridge 156:ff21514d8981 3
AnnaBridge 156:ff21514d8981 4 /* mbed Microcontroller Library
AnnaBridge 156:ff21514d8981 5 * Copyright (c) 2017 ARM Limited
AnnaBridge 172:65be27845400 6 * SPDX-License-Identifier: Apache-2.0
AnnaBridge 156:ff21514d8981 7 *
AnnaBridge 156:ff21514d8981 8 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 156:ff21514d8981 9 * you may not use this file except in compliance with the License.
AnnaBridge 156:ff21514d8981 10 * You may obtain a copy of the License at
AnnaBridge 156:ff21514d8981 11 *
AnnaBridge 156:ff21514d8981 12 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 156:ff21514d8981 13 *
AnnaBridge 156:ff21514d8981 14 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 156:ff21514d8981 15 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 156:ff21514d8981 16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 156:ff21514d8981 17 * See the License for the specific language governing permissions and
AnnaBridge 156:ff21514d8981 18 * limitations under the License.
AnnaBridge 156:ff21514d8981 19 */
AnnaBridge 156:ff21514d8981 20 #ifndef MBED_FLASH_API_H
AnnaBridge 156:ff21514d8981 21 #define MBED_FLASH_API_H
AnnaBridge 156:ff21514d8981 22
AnnaBridge 156:ff21514d8981 23 #include "device.h"
AnnaBridge 156:ff21514d8981 24 #include <stdint.h>
AnnaBridge 156:ff21514d8981 25
AnnaBridge 156:ff21514d8981 26 #if DEVICE_FLASH
AnnaBridge 156:ff21514d8981 27
AnnaBridge 156:ff21514d8981 28 #define MBED_FLASH_INVALID_SIZE 0xFFFFFFFF
AnnaBridge 156:ff21514d8981 29
AnnaBridge 156:ff21514d8981 30 typedef struct flash_s flash_t;
AnnaBridge 156:ff21514d8981 31
AnnaBridge 156:ff21514d8981 32 #if TARGET_FLASH_CMSIS_ALGO
AnnaBridge 156:ff21514d8981 33 #include "flash_data.h"
AnnaBridge 156:ff21514d8981 34 #endif
AnnaBridge 156:ff21514d8981 35
AnnaBridge 156:ff21514d8981 36 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 37 extern "C" {
AnnaBridge 156:ff21514d8981 38 #endif
AnnaBridge 156:ff21514d8981 39
AnnaBridge 156:ff21514d8981 40 /**
AnnaBridge 156:ff21514d8981 41 * \defgroup flash_hal Flash HAL API
AnnaBridge 156:ff21514d8981 42 * @{
AnnaBridge 156:ff21514d8981 43 */
AnnaBridge 156:ff21514d8981 44
AnnaBridge 156:ff21514d8981 45 /** Initialize the flash peripheral and the flash_t object
AnnaBridge 156:ff21514d8981 46 *
AnnaBridge 156:ff21514d8981 47 * @param obj The flash object
AnnaBridge 156:ff21514d8981 48 * @return 0 for success, -1 for error
AnnaBridge 156:ff21514d8981 49 */
AnnaBridge 156:ff21514d8981 50 int32_t flash_init(flash_t *obj);
AnnaBridge 156:ff21514d8981 51
AnnaBridge 156:ff21514d8981 52 /** Uninitialize the flash peripheral and the flash_t object
AnnaBridge 156:ff21514d8981 53 *
AnnaBridge 156:ff21514d8981 54 * @param obj The flash object
AnnaBridge 156:ff21514d8981 55 * @return 0 for success, -1 for error
AnnaBridge 156:ff21514d8981 56 */
AnnaBridge 156:ff21514d8981 57 int32_t flash_free(flash_t *obj);
AnnaBridge 156:ff21514d8981 58
AnnaBridge 156:ff21514d8981 59 /** Erase one sector starting at defined address
AnnaBridge 156:ff21514d8981 60 *
AnnaBridge 156:ff21514d8981 61 * The address should be at sector boundary. This function does not do any check for address alignments
AnnaBridge 156:ff21514d8981 62 * @param obj The flash object
AnnaBridge 156:ff21514d8981 63 * @param address The sector starting address
AnnaBridge 156:ff21514d8981 64 * @return 0 for success, -1 for error
AnnaBridge 156:ff21514d8981 65 */
AnnaBridge 156:ff21514d8981 66 int32_t flash_erase_sector(flash_t *obj, uint32_t address);
AnnaBridge 156:ff21514d8981 67
AnnaBridge 156:ff21514d8981 68 /** Read data starting at defined address
AnnaBridge 156:ff21514d8981 69 *
AnnaBridge 156:ff21514d8981 70 * This function has a WEAK implementation using memcpy for backwards compatibility.
AnnaBridge 156:ff21514d8981 71 * @param obj The flash object
AnnaBridge 156:ff21514d8981 72 * @param address Address to begin reading from
AnnaBridge 156:ff21514d8981 73 * @param data The buffer to read data into
AnnaBridge 156:ff21514d8981 74 * @param size The number of bytes to read
AnnaBridge 156:ff21514d8981 75 * @return 0 for success, -1 for error
AnnaBridge 156:ff21514d8981 76 */
AnnaBridge 156:ff21514d8981 77 int32_t flash_read(flash_t *obj, uint32_t address, uint8_t *data, uint32_t size);
AnnaBridge 156:ff21514d8981 78
AnnaBridge 156:ff21514d8981 79 /** Program pages starting at defined address
AnnaBridge 156:ff21514d8981 80 *
AnnaBridge 156:ff21514d8981 81 * The pages should not cross multiple sectors.
AnnaBridge 156:ff21514d8981 82 * This function does not do any check for address alignments or if size is aligned to a page size.
AnnaBridge 156:ff21514d8981 83 * @param obj The flash object
AnnaBridge 156:ff21514d8981 84 * @param address The sector starting address
AnnaBridge 156:ff21514d8981 85 * @param data The data buffer to be programmed
AnnaBridge 156:ff21514d8981 86 * @param size The number of bytes to program
AnnaBridge 156:ff21514d8981 87 * @return 0 for success, -1 for error
AnnaBridge 156:ff21514d8981 88 */
AnnaBridge 156:ff21514d8981 89 int32_t flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data, uint32_t size);
AnnaBridge 156:ff21514d8981 90
AnnaBridge 156:ff21514d8981 91 /** Get sector size
AnnaBridge 156:ff21514d8981 92 *
AnnaBridge 156:ff21514d8981 93 * @param obj The flash object
AnnaBridge 156:ff21514d8981 94 * @param address The sector starting address
AnnaBridge 156:ff21514d8981 95 * @return The size of a sector
AnnaBridge 156:ff21514d8981 96 */
AnnaBridge 156:ff21514d8981 97 uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address);
AnnaBridge 156:ff21514d8981 98
AnnaBridge 156:ff21514d8981 99 /** Get page size
AnnaBridge 156:ff21514d8981 100 *
AnnaBridge 156:ff21514d8981 101 * The page size defines the writable page size
AnnaBridge 156:ff21514d8981 102 * @param obj The flash object
AnnaBridge 156:ff21514d8981 103 * @return The size of a page
AnnaBridge 156:ff21514d8981 104 */
AnnaBridge 156:ff21514d8981 105 uint32_t flash_get_page_size(const flash_t *obj);
AnnaBridge 156:ff21514d8981 106
AnnaBridge 156:ff21514d8981 107 /** Get start address for the flash region
AnnaBridge 156:ff21514d8981 108 *
AnnaBridge 156:ff21514d8981 109 * @param obj The flash object
AnnaBridge 156:ff21514d8981 110 * @return The start address for the flash region
AnnaBridge 156:ff21514d8981 111 */
AnnaBridge 156:ff21514d8981 112 uint32_t flash_get_start_address(const flash_t *obj);
AnnaBridge 156:ff21514d8981 113
AnnaBridge 156:ff21514d8981 114 /** Get the flash region size
AnnaBridge 156:ff21514d8981 115 *
AnnaBridge 156:ff21514d8981 116 * @param obj The flash object
AnnaBridge 156:ff21514d8981 117 * @return The flash region size
AnnaBridge 156:ff21514d8981 118 */
AnnaBridge 156:ff21514d8981 119 uint32_t flash_get_size(const flash_t *obj);
AnnaBridge 156:ff21514d8981 120
AnnaBridge 172:65be27845400 121 /** Get the flash erase value
AnnaBridge 172:65be27845400 122 *
AnnaBridge 172:65be27845400 123 * @param obj The flash object
AnnaBridge 172:65be27845400 124 * @return The flash erase value
AnnaBridge 172:65be27845400 125 */
AnnaBridge 172:65be27845400 126 uint8_t flash_get_erase_value(const flash_t *obj);
AnnaBridge 172:65be27845400 127
AnnaBridge 156:ff21514d8981 128 /**@}*/
AnnaBridge 156:ff21514d8981 129
AnnaBridge 156:ff21514d8981 130 #ifdef __cplusplus
AnnaBridge 156:ff21514d8981 131 }
AnnaBridge 156:ff21514d8981 132 #endif
AnnaBridge 156:ff21514d8981 133
AnnaBridge 156:ff21514d8981 134 #endif
AnnaBridge 156:ff21514d8981 135
AnnaBridge 156:ff21514d8981 136 #endif
AnnaBridge 156:ff21514d8981 137
AnnaBridge 156:ff21514d8981 138 /** @}*/