Mohamed Moawya / SnakeGame

test test test

Dependencies:   mbed

snake-test/mbed/hal/flash_api.h@0:e4c5e6ec922e, 2020-05-25 (annotated)

Committer:
mohamedmoawya
Date:
Mon May 25 19:06:11 2020 +0000
Revision:
0:e4c5e6ec922e
snake game tteest

Who changed what in which revision?

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