Elijah Stanger-Jones / mbed-dev

Lightweight Mbed Library for STM F4 and F7

hal/flash_api.h@2:0edeaf13dfb2, 2021-02-04 (annotated)

Committer:
elijahsj
Date:
Thu Feb 04 20:44:34 2021 +0000
Revision:
2:0edeaf13dfb2
Parent:
0:083111ae2a11 
modfiied for spine board;

Who changed what in which revision?

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