Daiki Kato / mbed-os-lychee

mbed-os for GR-LYCHEE

Dependents:   mbed-os-example-blinky-gr-lychee GR-Boads_Camera_sample GR-Boards_Audio_Recoder GR-Boads_Camera_DisplayApp ... more

hal/flash_api.h@0:f782d9c66c49, 2018-02-02 (annotated)

Committer:
dkato
Date:
Fri Feb 02 05:42:23 2018 +0000
Revision:
0:f782d9c66c49
mbed-os for GR-LYCHEE

Who changed what in which revision?

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