Gan likun / The prosthetic control

The prosthetic control（MIT）

hal/flash_api.h@0:20e0c61e0684, 2022-06-23 (annotated)

Committer:
ganlikun
Date:
Thu Jun 23 05:23:34 2022 +0000
Revision:
0:20e0c61e0684
01

Who changed what in which revision?

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