Kev Mann / mbed-dev-OS5_10_4

RTC auf true

hal/flash_api.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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