The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.
Dependents: hello SerialTestv11 SerialTestv12 Sierpinski ... more
mbed 2
This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.
hal/flash_api.h@138:093f2bd7b9eb, 2017-03-14 (annotated)
- Committer:
- <>
- Date:
- Tue Mar 14 16:20:51 2017 +0000
- Revision:
- 138:093f2bd7b9eb
- Child:
- 147:a97add6d7e64
Release 138 of the mbed library
Ports for Upcoming Targets
Fixes and Changes
3716: fix for issue #3715: correction in startup files for ARM and IAR, alignment of system_stm32f429xx.c files https://github.com/ARMmbed/mbed-os/pull/3716
3741: STM32 remove warning in hal_tick_32b.c file https://github.com/ARMmbed/mbed-os/pull/3741
3780: STM32L4 : Fix GPIO G port compatibility https://github.com/ARMmbed/mbed-os/pull/3780
3831: NCS36510: SPISLAVE enabled (Conflict resolved) https://github.com/ARMmbed/mbed-os/pull/3831
3836: Allow to redefine nRF's PSTORAGE_NUM_OF_PAGES outside of the mbed-os https://github.com/ARMmbed/mbed-os/pull/3836
3840: STM32: gpio SPEED - always set High Speed by default https://github.com/ARMmbed/mbed-os/pull/3840
3844: STM32 GPIO: Typo correction. Update comment (GPIO_IP_WITHOUT_BRR) https://github.com/ARMmbed/mbed-os/pull/3844
3850: STM32: change spi error to debug warning https://github.com/ARMmbed/mbed-os/pull/3850
3860: Define GPIO_IP_WITHOUT_BRR for xDot platform https://github.com/ARMmbed/mbed-os/pull/3860
3880: DISCO_F469NI: allow the use of CAN2 instance when CAN1 is not activated https://github.com/ARMmbed/mbed-os/pull/3880
3795: Fix pwm period calc https://github.com/ARMmbed/mbed-os/pull/3795
3828: STM32 CAN API: correct format and type https://github.com/ARMmbed/mbed-os/pull/3828
3842: TARGET_NRF: corrected spi_init() to properly handle re-initialization https://github.com/ARMmbed/mbed-os/pull/3842
3843: STM32L476xG: set APB2 clock to 80MHz (instead of 40MHz) https://github.com/ARMmbed/mbed-os/pull/3843
3879: NUCLEO_F446ZE: Add missing AnalogIn pins on PF_3, PF_5 and PF_10. https://github.com/ARMmbed/mbed-os/pull/3879
3902: Fix heap and stack size for NUCLEO_F746ZG https://github.com/ARMmbed/mbed-os/pull/3902
3829: can_write(): return error code when no tx mailboxes are available https://github.com/ARMmbed/mbed-os/pull/3829
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
<> | 138:093f2bd7b9eb | 1 | /** \addtogroup hal */ |
<> | 138:093f2bd7b9eb | 2 | /** @{*/ |
<> | 138:093f2bd7b9eb | 3 | |
<> | 138:093f2bd7b9eb | 4 | /* mbed Microcontroller Library |
<> | 138:093f2bd7b9eb | 5 | * Copyright (c) 2017 ARM Limited |
<> | 138:093f2bd7b9eb | 6 | * |
<> | 138:093f2bd7b9eb | 7 | * Licensed under the Apache License, Version 2.0 (the "License"); |
<> | 138:093f2bd7b9eb | 8 | * you may not use this file except in compliance with the License. |
<> | 138:093f2bd7b9eb | 9 | * You may obtain a copy of the License at |
<> | 138:093f2bd7b9eb | 10 | * |
<> | 138:093f2bd7b9eb | 11 | * http://www.apache.org/licenses/LICENSE-2.0 |
<> | 138:093f2bd7b9eb | 12 | * |
<> | 138:093f2bd7b9eb | 13 | * Unless required by applicable law or agreed to in writing, software |
<> | 138:093f2bd7b9eb | 14 | * distributed under the License is distributed on an "AS IS" BASIS, |
<> | 138:093f2bd7b9eb | 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
<> | 138:093f2bd7b9eb | 16 | * See the License for the specific language governing permissions and |
<> | 138:093f2bd7b9eb | 17 | * limitations under the License. |
<> | 138:093f2bd7b9eb | 18 | */ |
<> | 138:093f2bd7b9eb | 19 | #ifndef MBED_FLASH_API_H |
<> | 138:093f2bd7b9eb | 20 | #define MBED_FLASH_API_H |
<> | 138:093f2bd7b9eb | 21 | |
<> | 138:093f2bd7b9eb | 22 | #include "device.h" |
<> | 138:093f2bd7b9eb | 23 | #include <stdint.h> |
<> | 138:093f2bd7b9eb | 24 | |
<> | 138:093f2bd7b9eb | 25 | #if DEVICE_FLASH |
<> | 138:093f2bd7b9eb | 26 | |
<> | 138:093f2bd7b9eb | 27 | #define MBED_FLASH_INVALID_SIZE 0xFFFFFFFF |
<> | 138:093f2bd7b9eb | 28 | |
<> | 138:093f2bd7b9eb | 29 | typedef struct flash_s flash_t; |
<> | 138:093f2bd7b9eb | 30 | |
<> | 138:093f2bd7b9eb | 31 | #if TARGET_FLASH_CMSIS_ALGO |
<> | 138:093f2bd7b9eb | 32 | #include "flash_data.h" |
<> | 138:093f2bd7b9eb | 33 | #endif |
<> | 138:093f2bd7b9eb | 34 | |
<> | 138:093f2bd7b9eb | 35 | #ifdef __cplusplus |
<> | 138:093f2bd7b9eb | 36 | extern "C" { |
<> | 138:093f2bd7b9eb | 37 | #endif |
<> | 138:093f2bd7b9eb | 38 | |
<> | 138:093f2bd7b9eb | 39 | /** |
<> | 138:093f2bd7b9eb | 40 | * \defgroup flash_hal Flash HAL API |
<> | 138:093f2bd7b9eb | 41 | * @{ |
<> | 138:093f2bd7b9eb | 42 | */ |
<> | 138:093f2bd7b9eb | 43 | |
<> | 138:093f2bd7b9eb | 44 | /** Initialize the flash peripheral and the flash_t object |
<> | 138:093f2bd7b9eb | 45 | * |
<> | 138:093f2bd7b9eb | 46 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 47 | * @return 0 for success, -1 for error |
<> | 138:093f2bd7b9eb | 48 | */ |
<> | 138:093f2bd7b9eb | 49 | int32_t flash_init(flash_t *obj); |
<> | 138:093f2bd7b9eb | 50 | |
<> | 138:093f2bd7b9eb | 51 | /** Uninitialize the flash peripheral and the flash_t object |
<> | 138:093f2bd7b9eb | 52 | * |
<> | 138:093f2bd7b9eb | 53 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 54 | * @return 0 for success, -1 for error |
<> | 138:093f2bd7b9eb | 55 | */ |
<> | 138:093f2bd7b9eb | 56 | int32_t flash_free(flash_t *obj); |
<> | 138:093f2bd7b9eb | 57 | |
<> | 138:093f2bd7b9eb | 58 | /** Erase one sector starting at defined address |
<> | 138:093f2bd7b9eb | 59 | * |
<> | 138:093f2bd7b9eb | 60 | * The address should be at sector boundary. This function does not do any check for address alignments |
<> | 138:093f2bd7b9eb | 61 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 62 | * @param address The sector starting address |
<> | 138:093f2bd7b9eb | 63 | * @return 0 for success, -1 for error |
<> | 138:093f2bd7b9eb | 64 | */ |
<> | 138:093f2bd7b9eb | 65 | int32_t flash_erase_sector(flash_t *obj, uint32_t address); |
<> | 138:093f2bd7b9eb | 66 | |
<> | 138:093f2bd7b9eb | 67 | /** Program one page starting at defined address |
<> | 138:093f2bd7b9eb | 68 | * |
<> | 138:093f2bd7b9eb | 69 | * The page should be at page boundary, should not cross multiple sectors. |
<> | 138:093f2bd7b9eb | 70 | * This function does not do any check for address alignments or if size is aligned to a page size. |
<> | 138:093f2bd7b9eb | 71 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 72 | * @param address The sector starting address |
<> | 138:093f2bd7b9eb | 73 | * @param data The data buffer to be programmed |
<> | 138:093f2bd7b9eb | 74 | * @param size The number of bytes to program |
<> | 138:093f2bd7b9eb | 75 | * @return 0 for success, -1 for error |
<> | 138:093f2bd7b9eb | 76 | */ |
<> | 138:093f2bd7b9eb | 77 | int32_t flash_program_page(flash_t *obj, uint32_t address, const uint8_t *data, uint32_t size); |
<> | 138:093f2bd7b9eb | 78 | |
<> | 138:093f2bd7b9eb | 79 | /** Get sector size |
<> | 138:093f2bd7b9eb | 80 | * |
<> | 138:093f2bd7b9eb | 81 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 82 | * @param address The sector starting address |
<> | 138:093f2bd7b9eb | 83 | * @return The size of a sector |
<> | 138:093f2bd7b9eb | 84 | */ |
<> | 138:093f2bd7b9eb | 85 | uint32_t flash_get_sector_size(const flash_t *obj, uint32_t address); |
<> | 138:093f2bd7b9eb | 86 | |
<> | 138:093f2bd7b9eb | 87 | /** Get page size |
<> | 138:093f2bd7b9eb | 88 | * |
<> | 138:093f2bd7b9eb | 89 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 90 | * @param address The page starting address |
<> | 138:093f2bd7b9eb | 91 | * @return The size of a page |
<> | 138:093f2bd7b9eb | 92 | */ |
<> | 138:093f2bd7b9eb | 93 | uint32_t flash_get_page_size(const flash_t *obj); |
<> | 138:093f2bd7b9eb | 94 | |
<> | 138:093f2bd7b9eb | 95 | /** Get start address for the flash region |
<> | 138:093f2bd7b9eb | 96 | * |
<> | 138:093f2bd7b9eb | 97 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 98 | * @return The start address for the flash region |
<> | 138:093f2bd7b9eb | 99 | */ |
<> | 138:093f2bd7b9eb | 100 | uint32_t flash_get_start_address(const flash_t *obj); |
<> | 138:093f2bd7b9eb | 101 | |
<> | 138:093f2bd7b9eb | 102 | /** Get the flash region size |
<> | 138:093f2bd7b9eb | 103 | * |
<> | 138:093f2bd7b9eb | 104 | * @param obj The flash object |
<> | 138:093f2bd7b9eb | 105 | * @return The flash region size |
<> | 138:093f2bd7b9eb | 106 | */ |
<> | 138:093f2bd7b9eb | 107 | uint32_t flash_get_size(const flash_t *obj); |
<> | 138:093f2bd7b9eb | 108 | |
<> | 138:093f2bd7b9eb | 109 | /**@}*/ |
<> | 138:093f2bd7b9eb | 110 | |
<> | 138:093f2bd7b9eb | 111 | #ifdef __cplusplus |
<> | 138:093f2bd7b9eb | 112 | } |
<> | 138:093f2bd7b9eb | 113 | #endif |
<> | 138:093f2bd7b9eb | 114 | |
<> | 138:093f2bd7b9eb | 115 | #endif |
<> | 138:093f2bd7b9eb | 116 | |
<> | 138:093f2bd7b9eb | 117 | #endif |
<> | 138:093f2bd7b9eb | 118 | |
<> | 138:093f2bd7b9eb | 119 | /** @}*/ |