EL4121 Embedded System / mbed-os

mbed-os

Dependents:   cobaLCDJoyMotor_Thread odometry_omni_3roda_v3 odometry_omni_3roda_v1 odometry_omni_3roda_v2 ... more

hal/flash_api.h@0:b74591d5ab33, 2017-12-11 (annotated)

Committer:
be_bryan
Date:
Mon Dec 11 17:54:04 2017 +0000
Revision:
0:b74591d5ab33
motor ++

Who changed what in which revision?

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