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@151:675da3299148, 2017-09-15 (annotated)

Committer:
AnnaBridge
Date:
Fri Sep 15 14:46:57 2017 +0100
Revision:
151:675da3299148
Parent:
150:a330f0fddbec
Child:
152:235179ab3f27
Release 151 of the mbed library.

Who changed what in which revision?

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