Marco Mayer / Mbed OS Queue

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

mbed-os/hal/flash_api.h@0:6bf0743ece18, 2020-03-28 (annotated)

Committer:
demayer
Date:
Sat Mar 28 15:28:19 2020 +0000
Revision:
0:6bf0743ece18
IMU Thread with an event-queue running parallel to handle tasks like a 5 times blinking LED. Button with interrupt detected.

Who changed what in which revision?

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