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@157:e7ca05fa8600, 2017-11-09 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 09 11:14:10 2017 +0000
Revision:
157:e7ca05fa8600
Parent:
156:ff21514d8981
Child:
172:65be27845400
Release 155 of the mbed library.

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