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/storage_abstraction/Driver_Storage.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
demayer 0:6bf0743ece18 2 /** \addtogroup hal */
demayer 0:6bf0743ece18 3 /** @{*/
demayer 0:6bf0743ece18 4 /*
demayer 0:6bf0743ece18 5 * Copyright (c) 2006-2016, ARM Limited, All Rights Reserved
demayer 0:6bf0743ece18 6 * SPDX-License-Identifier: Apache-2.0
demayer 0:6bf0743ece18 7 *
demayer 0:6bf0743ece18 8 * Licensed under the Apache License, Version 2.0 (the "License"); you may
demayer 0:6bf0743ece18 9 * not use this file except in compliance with the License.
demayer 0:6bf0743ece18 10 * You may obtain a copy of the License at
demayer 0:6bf0743ece18 11 *
demayer 0:6bf0743ece18 12 * http://www.apache.org/licenses/LICENSE-2.0
demayer 0:6bf0743ece18 13 *
demayer 0:6bf0743ece18 14 * Unless required by applicable law or agreed to in writing, software
demayer 0:6bf0743ece18 15 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
demayer 0:6bf0743ece18 16 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
demayer 0:6bf0743ece18 17 * See the License for the specific language governing permissions and
demayer 0:6bf0743ece18 18 * limitations under the License.
demayer 0:6bf0743ece18 19 */
demayer 0:6bf0743ece18 20
demayer 0:6bf0743ece18 21 #ifndef __DRIVER_STORAGE_H
demayer 0:6bf0743ece18 22 #define __DRIVER_STORAGE_H
demayer 0:6bf0743ece18 23
demayer 0:6bf0743ece18 24 #include <stdint.h>
demayer 0:6bf0743ece18 25
demayer 0:6bf0743ece18 26 /****** This file has been deprecated since mbed-os-5.5 *****/
demayer 0:6bf0743ece18 27
demayer 0:6bf0743ece18 28 #ifdef __cplusplus
demayer 0:6bf0743ece18 29 extern "C" {
demayer 0:6bf0743ece18 30 #endif // __cplusplus
demayer 0:6bf0743ece18 31
demayer 0:6bf0743ece18 32 #include "Driver_Common.h"
demayer 0:6bf0743ece18 33
demayer 0:6bf0743ece18 34 #define ARM_STORAGE_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(1,00) /* API version */
demayer 0:6bf0743ece18 35
demayer 0:6bf0743ece18 36
demayer 0:6bf0743ece18 37 #define _ARM_Driver_Storage_(n) Driver_Storage##n
demayer 0:6bf0743ece18 38 #define ARM_Driver_Storage_(n) _ARM_Driver_Storage_(n)
demayer 0:6bf0743ece18 39
demayer 0:6bf0743ece18 40 #define ARM_STORAGE_INVALID_OFFSET (0xFFFFFFFFFFFFFFFFULL) ///< Invalid address (relative to a storage controller's
demayer 0:6bf0743ece18 41 ///< address space). A storage block may never start at this address.
demayer 0:6bf0743ece18 42
demayer 0:6bf0743ece18 43 #define ARM_STORAGE_INVALID_ADDRESS (0xFFFFFFFFUL) ///< Invalid address within the processor's memory address space.
demayer 0:6bf0743ece18 44 ///< Refer to memory-mapped storage, i.e. < \ref ARM_DRIVER_STORAGE::ResolveAddress().
demayer 0:6bf0743ece18 45
demayer 0:6bf0743ece18 46 /****** Storage specific error codes *****/
demayer 0:6bf0743ece18 47 #define ARM_STORAGE_ERROR_NOT_ERASABLE (ARM_DRIVER_ERROR_SPECIFIC - 1) ///< Part (or all) of the range provided to Erase() isn't erasable.
demayer 0:6bf0743ece18 48 #define ARM_STORAGE_ERROR_NOT_PROGRAMMABLE (ARM_DRIVER_ERROR_SPECIFIC - 2) ///< Part (or all) of the range provided to ProgramData() isn't programmable.
demayer 0:6bf0743ece18 49 #define ARM_STORAGE_ERROR_PROTECTED (ARM_DRIVER_ERROR_SPECIFIC - 3) ///< Part (or all) of the range to Erase() or ProgramData() is protected.
demayer 0:6bf0743ece18 50 #define ARM_STORAGE_ERROR_RUNTIME_OR_INTEGRITY_FAILURE (ARM_DRIVER_ERROR_SPECIFIC - 4) ///< Runtime or sanity-check failure.
demayer 0:6bf0743ece18 51
demayer 0:6bf0743ece18 52 /**
demayer 0:6bf0743ece18 53 * \brief Attributes of the storage range within a storage block.
demayer 0:6bf0743ece18 54 */
demayer 0:6bf0743ece18 55 typedef struct _ARM_STORAGE_BLOCK_ATTRIBUTES {
demayer 0:6bf0743ece18 56 uint32_t erasable : 1; ///< Erasing blocks is permitted with a minimum granularity of 'erase_unit'.
demayer 0:6bf0743ece18 57 ///< @note: if 'erasable' is 0--i.e. the 'erase' operation isn't available--then
demayer 0:6bf0743ece18 58 ///< 'erase_unit' (see below) is immaterial and should be 0.
demayer 0:6bf0743ece18 59 uint32_t programmable : 1; ///< Writing to ranges is permitted with a minimum granularity of 'program_unit'.
demayer 0:6bf0743ece18 60 ///< Writes are typically achieved through the ProgramData operation (following an erase);
demayer 0:6bf0743ece18 61 ///< if storage isn't erasable (see 'erasable' above) but is memory-mapped
demayer 0:6bf0743ece18 62 ///< (i.e. 'memory_mapped'), it can be written directly using memory-store operations.
demayer 0:6bf0743ece18 63 uint32_t executable : 1; ///< This storage block can hold program data; the processor can fetch and execute code
demayer 0:6bf0743ece18 64 ///< sourced from it. Often this is accompanied with the device being 'memory_mapped' (see \ref ARM_STORAGE_INFO).
demayer 0:6bf0743ece18 65 uint32_t protectable : 1; ///< The entire block can be protected from program and erase operations. Once protection
demayer 0:6bf0743ece18 66 ///< is enabled for a block, its 'erasable' and 'programmable' bits are turned off.
demayer 0:6bf0743ece18 67 uint32_t reserved : 28;
demayer 0:6bf0743ece18 68 uint32_t erase_unit; ///< Minimum erase size in bytes.
demayer 0:6bf0743ece18 69 ///< The offset of the start of the erase-range should also be aligned with this value.
demayer 0:6bf0743ece18 70 ///< Applicable if the 'erasable' attribute is set for the block.
demayer 0:6bf0743ece18 71 ///< @note: if 'erasable' (see above) is 0--i.e. the 'erase' operation isn't available--then
demayer 0:6bf0743ece18 72 ///< 'erase_unit' is immaterial and should be 0.
demayer 0:6bf0743ece18 73 uint32_t protection_unit; ///< Minimum protectable size in bytes. Applicable if the 'protectable'
demayer 0:6bf0743ece18 74 ///< attribute is set for the block. This should be a divisor of the block's size. A
demayer 0:6bf0743ece18 75 ///< block can be considered to be made up of consecutive, individually-protectable fragments.
demayer 0:6bf0743ece18 76 } ARM_STORAGE_BLOCK_ATTRIBUTES;
demayer 0:6bf0743ece18 77
demayer 0:6bf0743ece18 78 /**
demayer 0:6bf0743ece18 79 * \brief A storage block is a range of memory with uniform attributes. Storage blocks
demayer 0:6bf0743ece18 80 * combine to make up the address map of a storage controller.
demayer 0:6bf0743ece18 81 */
demayer 0:6bf0743ece18 82 typedef struct _ARM_STORAGE_BLOCK {
demayer 0:6bf0743ece18 83 uint64_t addr; ///< This is the start address of the storage block. It is
demayer 0:6bf0743ece18 84 ///< expressed as an offset from the start of the storage map
demayer 0:6bf0743ece18 85 ///< maintained by the owning storage controller.
demayer 0:6bf0743ece18 86 uint64_t size; ///< This is the size of the storage block, in units of bytes.
demayer 0:6bf0743ece18 87 ///< Together with addr, it describes a range [addr, addr+size).
demayer 0:6bf0743ece18 88 ARM_STORAGE_BLOCK_ATTRIBUTES attributes; ///< Attributes for this block.
demayer 0:6bf0743ece18 89 } ARM_STORAGE_BLOCK;
demayer 0:6bf0743ece18 90
demayer 0:6bf0743ece18 91 /**
demayer 0:6bf0743ece18 92 * The check for a valid ARM_STORAGE_BLOCK.
demayer 0:6bf0743ece18 93 */
demayer 0:6bf0743ece18 94 #define ARM_STORAGE_VALID_BLOCK(BLK) (((BLK)->addr != ARM_STORAGE_INVALID_OFFSET) && ((BLK)->size != 0))
demayer 0:6bf0743ece18 95
demayer 0:6bf0743ece18 96 /**
demayer 0:6bf0743ece18 97 * \brief Values for encoding storage memory-types with respect to programmability.
demayer 0:6bf0743ece18 98 *
demayer 0:6bf0743ece18 99 * Please ensure that the maximum of the following memory types doesn't exceed 16; we
demayer 0:6bf0743ece18 100 * encode this in a 4-bit field within ARM_STORAGE_INFO::programmability.
demayer 0:6bf0743ece18 101 */
demayer 0:6bf0743ece18 102 #define ARM_STORAGE_PROGRAMMABILITY_RAM (0x0)
demayer 0:6bf0743ece18 103 #define ARM_STORAGE_PROGRAMMABILITY_ROM (0x1) ///< Read-only memory.
demayer 0:6bf0743ece18 104 #define ARM_STORAGE_PROGRAMMABILITY_WORM (0x2) ///< write-once-read-only-memory (WORM).
demayer 0:6bf0743ece18 105 #define ARM_STORAGE_PROGRAMMABILITY_ERASABLE (0x3) ///< re-programmable based on erase. Supports multiple writes.
demayer 0:6bf0743ece18 106
demayer 0:6bf0743ece18 107 /**
demayer 0:6bf0743ece18 108 * Values for encoding data-retention levels for storage blocks.
demayer 0:6bf0743ece18 109 *
demayer 0:6bf0743ece18 110 * Please ensure that the maximum of the following retention types doesn't exceed 16; we
demayer 0:6bf0743ece18 111 * encode this in a 4-bit field within ARM_STORAGE_INFO::retention_level.
demayer 0:6bf0743ece18 112 */
demayer 0:6bf0743ece18 113 #define ARM_RETENTION_WHILE_DEVICE_ACTIVE (0x0) ///< Data is retained only during device activity.
demayer 0:6bf0743ece18 114 #define ARM_RETENTION_ACROSS_SLEEP (0x1) ///< Data is retained across processor sleep.
demayer 0:6bf0743ece18 115 #define ARM_RETENTION_ACROSS_DEEP_SLEEP (0x2) ///< Data is retained across processor deep-sleep.
demayer 0:6bf0743ece18 116 #define ARM_RETENTION_BATTERY_BACKED (0x3) ///< Data is battery-backed. Device can be powered off.
demayer 0:6bf0743ece18 117 #define ARM_RETENTION_NVM (0x4) ///< Data is retained in non-volatile memory.
demayer 0:6bf0743ece18 118
demayer 0:6bf0743ece18 119 /**
demayer 0:6bf0743ece18 120 * Device Data Security Protection Features. Applicable mostly to EXTERNAL_NVM.
demayer 0:6bf0743ece18 121 */
demayer 0:6bf0743ece18 122 typedef struct _ARM_STORAGE_SECURITY_FEATURES {
demayer 0:6bf0743ece18 123 uint32_t acls : 1; ///< Protection against internal software attacks using ACLs.
demayer 0:6bf0743ece18 124 uint32_t rollback_protection : 1; ///< Roll-back protection. Set to true if the creator of the storage
demayer 0:6bf0743ece18 125 ///< can ensure that an external attacker can't force an
demayer 0:6bf0743ece18 126 ///< older firmware to run or to revert back to a previous state.
demayer 0:6bf0743ece18 127 uint32_t tamper_proof : 1; ///< Tamper-proof memory (will be deleted on tamper-attempts using board level or chip level sensors).
demayer 0:6bf0743ece18 128 uint32_t internal_flash : 1; ///< Internal flash.
demayer 0:6bf0743ece18 129 uint32_t reserved1 : 12;
demayer 0:6bf0743ece18 130
demayer 0:6bf0743ece18 131 /**
demayer 0:6bf0743ece18 132 * Encode support for hardening against various classes of attacks.
demayer 0:6bf0743ece18 133 */
demayer 0:6bf0743ece18 134 uint32_t software_attacks : 1; ///< device software (malware running on the device).
demayer 0:6bf0743ece18 135 uint32_t board_level_attacks : 1; ///< board level attacks (debug probes, copy protection fuses.)
demayer 0:6bf0743ece18 136 uint32_t chip_level_attacks : 1; ///< chip level attacks (tamper-protection).
demayer 0:6bf0743ece18 137 uint32_t side_channel_attacks : 1; ///< side channel attacks.
demayer 0:6bf0743ece18 138 uint32_t reserved2 : 12;
demayer 0:6bf0743ece18 139 } ARM_STORAGE_SECURITY_FEATURES;
demayer 0:6bf0743ece18 140
demayer 0:6bf0743ece18 141 #define ARM_STORAGE_PROGRAM_CYCLES_INFINITE (0UL) /**< Infinite or unknown endurance for reprogramming. */
demayer 0:6bf0743ece18 142
demayer 0:6bf0743ece18 143 /**
demayer 0:6bf0743ece18 144 * \brief Storage information. This contains device-metadata. It is the return
demayer 0:6bf0743ece18 145 * value from calling GetInfo() on the storage driver.
demayer 0:6bf0743ece18 146 *
demayer 0:6bf0743ece18 147 * \details These fields serve a different purpose than the ones contained in
demayer 0:6bf0743ece18 148 * \ref ARM_STORAGE_CAPABILITIES, which is another structure containing
demayer 0:6bf0743ece18 149 * device-level metadata. ARM_STORAGE_CAPABILITIES describes the API
demayer 0:6bf0743ece18 150 * capabilities, whereas ARM_STORAGE_INFO describes the device. Furthermore
demayer 0:6bf0743ece18 151 * ARM_STORAGE_CAPABILITIES fits within a single word, and is designed to be
demayer 0:6bf0743ece18 152 * passed around by value; ARM_STORAGE_INFO, on the other hand, contains
demayer 0:6bf0743ece18 153 * metadata which doesn't fit into a single word and requires the use of
demayer 0:6bf0743ece18 154 * pointers to be moved around.
demayer 0:6bf0743ece18 155 */
demayer 0:6bf0743ece18 156 typedef struct _ARM_STORAGE_INFO {
demayer 0:6bf0743ece18 157 uint64_t total_storage; ///< Total available storage, in bytes.
demayer 0:6bf0743ece18 158 uint32_t program_unit; ///< Minimum programming size in bytes.
demayer 0:6bf0743ece18 159 ///< The offset of the start of the program-range should also be aligned with this value.
demayer 0:6bf0743ece18 160 ///< Applicable only if the 'programmable' attribute is set for a block.
demayer 0:6bf0743ece18 161 ///< @note: setting program_unit to 0 has the effect of disabling the size and alignment
demayer 0:6bf0743ece18 162 ///< restrictions (setting it to 1 also has the same effect).
demayer 0:6bf0743ece18 163 uint32_t optimal_program_unit; ///< Optimal programming page-size in bytes. Some storage controllers
demayer 0:6bf0743ece18 164 ///< have internal buffers into which to receive data. Writing in chunks of
demayer 0:6bf0743ece18 165 ///< 'optimal_program_unit' would achieve maximum programming speed.
demayer 0:6bf0743ece18 166 ///< Applicable only if the 'programmable' attribute is set for the underlying block(s).
demayer 0:6bf0743ece18 167 uint32_t program_cycles; ///< A measure of endurance for reprogramming.
demayer 0:6bf0743ece18 168 ///< Use ARM_STORAGE_PROGRAM_CYCLES_INFINITE for infinite or unknown endurance.
demayer 0:6bf0743ece18 169 uint32_t erased_value : 1; ///< Contents of erased memory (usually 1 to indicate erased bytes with state 0xFF).
demayer 0:6bf0743ece18 170 uint32_t memory_mapped : 1; ///< This storage device has a mapping onto the processor's memory address space.
demayer 0:6bf0743ece18 171 ///< @note: For a memory-mapped block which isn't erasable but is programmable (i.e. if
demayer 0:6bf0743ece18 172 ///< 'erasable' is set to 0, but 'programmable' is 1), writes should be possible directly to
demayer 0:6bf0743ece18 173 ///< the memory-mapped storage without going through the ProgramData operation.
demayer 0:6bf0743ece18 174 uint32_t programmability : 4; ///< A value to indicate storage programmability.
demayer 0:6bf0743ece18 175 uint32_t retention_level : 4;
demayer 0:6bf0743ece18 176 uint32_t reserved : 22;
demayer 0:6bf0743ece18 177 ARM_STORAGE_SECURITY_FEATURES security; ///< \ref ARM_STORAGE_SECURITY_FEATURES
demayer 0:6bf0743ece18 178 } ARM_STORAGE_INFO;
demayer 0:6bf0743ece18 179
demayer 0:6bf0743ece18 180 /**
demayer 0:6bf0743ece18 181 \brief Operating status of the storage controller.
demayer 0:6bf0743ece18 182 */
demayer 0:6bf0743ece18 183 typedef struct _ARM_STORAGE_STATUS {
demayer 0:6bf0743ece18 184 uint32_t busy : 1; ///< Controller busy flag
demayer 0:6bf0743ece18 185 uint32_t error : 1; ///< Read/Program/Erase error flag (cleared on start of next operation)
demayer 0:6bf0743ece18 186 } ARM_STORAGE_STATUS;
demayer 0:6bf0743ece18 187
demayer 0:6bf0743ece18 188 /**
demayer 0:6bf0743ece18 189 * \brief Storage Driver API Capabilities.
demayer 0:6bf0743ece18 190 *
demayer 0:6bf0743ece18 191 * This data structure is designed to fit within a single word so that it can be
demayer 0:6bf0743ece18 192 * fetched cheaply using a call to driver->GetCapabilities().
demayer 0:6bf0743ece18 193 */
demayer 0:6bf0743ece18 194 typedef struct _ARM_STORAGE_CAPABILITIES {
demayer 0:6bf0743ece18 195 uint32_t asynchronous_ops : 1; ///< Used to indicate if APIs like initialize,
demayer 0:6bf0743ece18 196 ///< read, erase, program, etc. can operate in asynchronous mode.
demayer 0:6bf0743ece18 197 ///< Setting this bit to 1 means that the driver is capable
demayer 0:6bf0743ece18 198 ///< of launching asynchronous operations; command completion is
demayer 0:6bf0743ece18 199 ///< signaled by the invocation of a completion callback. If
demayer 0:6bf0743ece18 200 ///< set to 1, drivers may still complete asynchronous
demayer 0:6bf0743ece18 201 ///< operations synchronously as necessary--in which case they
demayer 0:6bf0743ece18 202 ///< return a positive error code to indicate synchronous completion.
demayer 0:6bf0743ece18 203 uint32_t erase_all : 1; ///< Supports EraseAll operation.
demayer 0:6bf0743ece18 204 uint32_t reserved : 30;
demayer 0:6bf0743ece18 205 } ARM_STORAGE_CAPABILITIES;
demayer 0:6bf0743ece18 206
demayer 0:6bf0743ece18 207 /**
demayer 0:6bf0743ece18 208 * Command opcodes for Storage. Completion callbacks use these codes to refer to
demayer 0:6bf0743ece18 209 * completing commands. Refer to \ref ARM_Storage_Callback_t.
demayer 0:6bf0743ece18 210 */
demayer 0:6bf0743ece18 211 typedef enum _ARM_STORAGE_OPERATION {
demayer 0:6bf0743ece18 212 ARM_STORAGE_OPERATION_GET_VERSION,
demayer 0:6bf0743ece18 213 ARM_STORAGE_OPERATION_GET_CAPABILITIES,
demayer 0:6bf0743ece18 214 ARM_STORAGE_OPERATION_INITIALIZE,
demayer 0:6bf0743ece18 215 ARM_STORAGE_OPERATION_UNINITIALIZE,
demayer 0:6bf0743ece18 216 ARM_STORAGE_OPERATION_POWER_CONTROL,
demayer 0:6bf0743ece18 217 ARM_STORAGE_OPERATION_READ_DATA,
demayer 0:6bf0743ece18 218 ARM_STORAGE_OPERATION_PROGRAM_DATA,
demayer 0:6bf0743ece18 219 ARM_STORAGE_OPERATION_ERASE,
demayer 0:6bf0743ece18 220 ARM_STORAGE_OPERATION_ERASE_ALL,
demayer 0:6bf0743ece18 221 ARM_STORAGE_OPERATION_GET_STATUS,
demayer 0:6bf0743ece18 222 ARM_STORAGE_OPERATION_GET_INFO,
demayer 0:6bf0743ece18 223 ARM_STORAGE_OPERATION_RESOLVE_ADDRESS,
demayer 0:6bf0743ece18 224 ARM_STORAGE_OPERATION_GET_NEXT_BLOCK,
demayer 0:6bf0743ece18 225 ARM_STORAGE_OPERATION_GET_BLOCK
demayer 0:6bf0743ece18 226 } ARM_STORAGE_OPERATION;
demayer 0:6bf0743ece18 227
demayer 0:6bf0743ece18 228 /**
demayer 0:6bf0743ece18 229 * Declaration of the callback-type for command completion.
demayer 0:6bf0743ece18 230 *
demayer 0:6bf0743ece18 231 * @param [in] status
demayer 0:6bf0743ece18 232 * A code to indicate the status of the completed operation. For data
demayer 0:6bf0743ece18 233 * transfer operations, the status field is overloaded in case of
demayer 0:6bf0743ece18 234 * success to return the count of items successfully transferred; this
demayer 0:6bf0743ece18 235 * can be done safely because error codes are negative values.
demayer 0:6bf0743ece18 236 *
demayer 0:6bf0743ece18 237 * @param [in] operation
demayer 0:6bf0743ece18 238 * The command op-code. This value isn't essential for the callback in
demayer 0:6bf0743ece18 239 * the presence of the command instance-id, but it is expected that
demayer 0:6bf0743ece18 240 * this information could be a quick and useful filter.
demayer 0:6bf0743ece18 241 */
demayer 0:6bf0743ece18 242 typedef void (*ARM_Storage_Callback_t)(int32_t status, ARM_STORAGE_OPERATION operation);
demayer 0:6bf0743ece18 243
demayer 0:6bf0743ece18 244 /**
demayer 0:6bf0743ece18 245 * This is the set of operations constituting the Storage driver. Their
demayer 0:6bf0743ece18 246 * implementation is platform-specific, and needs to be supplied by the
demayer 0:6bf0743ece18 247 * porting effort.
demayer 0:6bf0743ece18 248 *
demayer 0:6bf0743ece18 249 * Some APIs within `ARM_DRIVER_STORAGE` will always operate synchronously:
demayer 0:6bf0743ece18 250 * GetVersion, GetCapabilities, GetStatus, GetInfo, ResolveAddress,
demayer 0:6bf0743ece18 251 * GetNextBlock, and GetBlock. This means that control returns to the caller
demayer 0:6bf0743ece18 252 * with a relevant status code only after the completion of the operation (or
demayer 0:6bf0743ece18 253 * the discovery of a failure condition).
demayer 0:6bf0743ece18 254 *
demayer 0:6bf0743ece18 255 * The remainder of the APIs: Initialize, Uninitialize, PowerControl, ReadData,
demayer 0:6bf0743ece18 256 * ProgramData, Erase, EraseAll, can function asynchronously if the underlying
demayer 0:6bf0743ece18 257 * controller supports it--i.e. if ARM_STORAGE_CAPABILITIES::asynchronous_ops is
demayer 0:6bf0743ece18 258 * set. In the case of asynchronous operation, the invocation returns early
demayer 0:6bf0743ece18 259 * (with ARM_DRIVER_OK) and results in a completion callback later. If
demayer 0:6bf0743ece18 260 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is not set, then all such APIs
demayer 0:6bf0743ece18 261 * execute synchronously, and control returns to the caller with a status code
demayer 0:6bf0743ece18 262 * only after the completion of the operation (or the discovery of a failure
demayer 0:6bf0743ece18 263 * condition).
demayer 0:6bf0743ece18 264 *
demayer 0:6bf0743ece18 265 * If ARM_STORAGE_CAPABILITIES::asynchronous_ops is set, a storage driver may
demayer 0:6bf0743ece18 266 * still choose to execute asynchronous operations in a synchronous manner. If
demayer 0:6bf0743ece18 267 * so, the driver returns a positive value to indicate successful synchronous
demayer 0:6bf0743ece18 268 * completion (or an error code in case of failure) and no further invocation of
demayer 0:6bf0743ece18 269 * completion callback should be expected. The expected return value for
demayer 0:6bf0743ece18 270 * synchronous completion of such asynchronous operations varies depending on
demayer 0:6bf0743ece18 271 * the operation. For operations involving data access, it often equals the
demayer 0:6bf0743ece18 272 * amount of data transferred or affected. For non data-transfer operations,
demayer 0:6bf0743ece18 273 * such as EraseAll or Initialize, it is usually 1.
demayer 0:6bf0743ece18 274 *
demayer 0:6bf0743ece18 275 * Here's a code snippet to suggest how asynchronous APIs might be used by
demayer 0:6bf0743ece18 276 * callers to handle both synchronous and asynchronous execution by the
demayer 0:6bf0743ece18 277 * underlying storage driver:
demayer 0:6bf0743ece18 278 * \code
demayer 0:6bf0743ece18 279 * ASSERT(ARM_DRIVER_OK == 0); // this is a precondition; it doesn't need to be put in code
demayer 0:6bf0743ece18 280 * int32_t returnValue = drv->asynchronousAPI(...);
demayer 0:6bf0743ece18 281 * if (returnValue < ARM_DRIVER_OK) {
demayer 0:6bf0743ece18 282 * // handle error.
demayer 0:6bf0743ece18 283 * } else if (returnValue == ARM_DRIVER_OK) {
demayer 0:6bf0743ece18 284 * ASSERT(drv->GetCapabilities().asynchronous_ops == 1);
demayer 0:6bf0743ece18 285 * // handle early return from asynchronous execution; remainder of the work is done in the callback handler.
demayer 0:6bf0743ece18 286 * } else {
demayer 0:6bf0743ece18 287 * ASSERT(returnValue == EXPECTED_RETURN_VALUE_FOR_SYNCHRONOUS_COMPLETION);
demayer 0:6bf0743ece18 288 * // handle synchronous completion.
demayer 0:6bf0743ece18 289 * }
demayer 0:6bf0743ece18 290 * \endcode
demayer 0:6bf0743ece18 291 */
demayer 0:6bf0743ece18 292 typedef struct _ARM_DRIVER_STORAGE {
demayer 0:6bf0743ece18 293 /**
demayer 0:6bf0743ece18 294 * \brief Get driver version.
demayer 0:6bf0743ece18 295 *
demayer 0:6bf0743ece18 296 * The function GetVersion() returns version information of the driver implementation in ARM_DRIVER_VERSION.
demayer 0:6bf0743ece18 297 *
demayer 0:6bf0743ece18 298 * - API version is the version of the CMSIS-Driver specification used to implement this driver.
demayer 0:6bf0743ece18 299 * - Driver version is source code version of the actual driver implementation.
demayer 0:6bf0743ece18 300 *
demayer 0:6bf0743ece18 301 * Example:
demayer 0:6bf0743ece18 302 * \code
demayer 0:6bf0743ece18 303 * extern ARM_DRIVER_STORAGE *drv_info;
demayer 0:6bf0743ece18 304 *
demayer 0:6bf0743ece18 305 * void read_version (void) {
demayer 0:6bf0743ece18 306 * ARM_DRIVER_VERSION version;
demayer 0:6bf0743ece18 307 *
demayer 0:6bf0743ece18 308 * version = drv_info->GetVersion ();
demayer 0:6bf0743ece18 309 * if (version.api < 0x10A) { // requires at minimum API version 1.10 or higher
demayer 0:6bf0743ece18 310 * // error handling
demayer 0:6bf0743ece18 311 * return;
demayer 0:6bf0743ece18 312 * }
demayer 0:6bf0743ece18 313 * }
demayer 0:6bf0743ece18 314 * \endcode
demayer 0:6bf0743ece18 315 *
demayer 0:6bf0743ece18 316 * @return \ref ARM_DRIVER_VERSION.
demayer 0:6bf0743ece18 317 *
demayer 0:6bf0743ece18 318 * @note This API returns synchronously--it does not result in an invocation
demayer 0:6bf0743ece18 319 * of a completion callback.
demayer 0:6bf0743ece18 320 *
demayer 0:6bf0743ece18 321 * @note The function GetVersion() can be called any time to obtain the
demayer 0:6bf0743ece18 322 * required information from the driver (even before initialization). It
demayer 0:6bf0743ece18 323 * always returns the same information.
demayer 0:6bf0743ece18 324 */
demayer 0:6bf0743ece18 325 ARM_DRIVER_VERSION (*GetVersion)(void);
demayer 0:6bf0743ece18 326
demayer 0:6bf0743ece18 327 /**
demayer 0:6bf0743ece18 328 * \brief Get driver capabilities.
demayer 0:6bf0743ece18 329 *
demayer 0:6bf0743ece18 330 * \details The function GetCapabilities() returns information about
demayer 0:6bf0743ece18 331 * capabilities in this driver implementation. The data fields of the struct
demayer 0:6bf0743ece18 332 * ARM_STORAGE_CAPABILITIES encode various capabilities, for example if the device
demayer 0:6bf0743ece18 333 * is able to execute operations asynchronously.
demayer 0:6bf0743ece18 334 *
demayer 0:6bf0743ece18 335 * Example:
demayer 0:6bf0743ece18 336 * \code
demayer 0:6bf0743ece18 337 * extern ARM_DRIVER_STORAGE *drv_info;
demayer 0:6bf0743ece18 338 *
demayer 0:6bf0743ece18 339 * void read_capabilities (void) {
demayer 0:6bf0743ece18 340 * ARM_STORAGE_CAPABILITIES drv_capabilities;
demayer 0:6bf0743ece18 341 *
demayer 0:6bf0743ece18 342 * drv_capabilities = drv_info->GetCapabilities ();
demayer 0:6bf0743ece18 343 * // interrogate capabilities
demayer 0:6bf0743ece18 344 *
demayer 0:6bf0743ece18 345 * }
demayer 0:6bf0743ece18 346 * \endcode
demayer 0:6bf0743ece18 347 *
demayer 0:6bf0743ece18 348 * @return \ref ARM_STORAGE_CAPABILITIES.
demayer 0:6bf0743ece18 349 *
demayer 0:6bf0743ece18 350 * @note This API returns synchronously--it does not result in an invocation
demayer 0:6bf0743ece18 351 * of a completion callback.
demayer 0:6bf0743ece18 352 *
demayer 0:6bf0743ece18 353 * @note The function GetCapabilities() can be called any time to obtain the
demayer 0:6bf0743ece18 354 * required information from the driver (even before initialization). It
demayer 0:6bf0743ece18 355 * always returns the same information.
demayer 0:6bf0743ece18 356 */
demayer 0:6bf0743ece18 357 ARM_STORAGE_CAPABILITIES (*GetCapabilities)(void);
demayer 0:6bf0743ece18 358
demayer 0:6bf0743ece18 359 /**
demayer 0:6bf0743ece18 360 * \brief Initialize the Storage Interface.
demayer 0:6bf0743ece18 361 *
demayer 0:6bf0743ece18 362 * The function Initialize is called when the middleware component starts
demayer 0:6bf0743ece18 363 * operation. In addition to bringing the controller to a ready state,
demayer 0:6bf0743ece18 364 * Initialize() receives a callback handler to be invoked upon completion of
demayer 0:6bf0743ece18 365 * asynchronous operations.
demayer 0:6bf0743ece18 366 *
demayer 0:6bf0743ece18 367 * Initialize() needs to be called explicitly before
demayer 0:6bf0743ece18 368 * powering the peripheral using PowerControl(), and before initiating other
demayer 0:6bf0743ece18 369 * accesses to the storage controller.
demayer 0:6bf0743ece18 370 *
demayer 0:6bf0743ece18 371 * The function performs the following operations:
demayer 0:6bf0743ece18 372 * - Initializes the resources needed for the Storage interface.
demayer 0:6bf0743ece18 373 * - Registers the \ref ARM_Storage_Callback_t callback function.
demayer 0:6bf0743ece18 374 *
demayer 0:6bf0743ece18 375 * To start working with a peripheral the functions Initialize and PowerControl need to be called in this order:
demayer 0:6bf0743ece18 376 * drv->Initialize (...); // Allocate I/O pins
demayer 0:6bf0743ece18 377 * drv->PowerControl (ARM_POWER_FULL); // Power up peripheral, setup IRQ/DMA
demayer 0:6bf0743ece18 378 *
demayer 0:6bf0743ece18 379 * - Initialize() typically allocates the I/O resources (pins) for the
demayer 0:6bf0743ece18 380 * peripheral. The function can be called multiple times; if the I/O resources
demayer 0:6bf0743ece18 381 * are already initialized it performs no operation and just returns with
demayer 0:6bf0743ece18 382 * ARM_DRIVER_OK.
demayer 0:6bf0743ece18 383 *
demayer 0:6bf0743ece18 384 * - PowerControl (ARM_POWER_FULL) sets the peripheral registers including
demayer 0:6bf0743ece18 385 * interrupt (NVIC) and optionally DMA. The function can be called multiple
demayer 0:6bf0743ece18 386 * times; if the registers are already set it performs no operation and just
demayer 0:6bf0743ece18 387 * returns with ARM_DRIVER_OK.
demayer 0:6bf0743ece18 388 *
demayer 0:6bf0743ece18 389 * To stop working with a peripheral the functions PowerControl and Uninitialize need to be called in this order:
demayer 0:6bf0743ece18 390 * drv->PowerControl (ARM_POWER_OFF); // Terminate any pending transfers, reset IRQ/DMA, power off peripheral
demayer 0:6bf0743ece18 391 * drv->Uninitialize (...); // Release I/O pins
demayer 0:6bf0743ece18 392 *
demayer 0:6bf0743ece18 393 * The functions PowerControl and Uninitialize always execute and can be used
demayer 0:6bf0743ece18 394 * to put the peripheral into a Safe State, for example after any data
demayer 0:6bf0743ece18 395 * transmission errors. To restart the peripheral in an error condition,
demayer 0:6bf0743ece18 396 * you should first execute the Stop Sequence and then the Start Sequence.
demayer 0:6bf0743ece18 397 *
demayer 0:6bf0743ece18 398 * @param [in] callback
demayer 0:6bf0743ece18 399 * Caller-defined callback to be invoked upon command completion
demayer 0:6bf0743ece18 400 * for asynchronous APIs (including the completion of
demayer 0:6bf0743ece18 401 * initialization). Use a NULL pointer when no callback
demayer 0:6bf0743ece18 402 * signals are required.
demayer 0:6bf0743ece18 403 *
demayer 0:6bf0743ece18 404 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 405 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 406 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 407 *
demayer 0:6bf0743ece18 408 * @return If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 409 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 410 * future with a status value of ARM_DRIVER_OK or an error-code. In the
demayer 0:6bf0743ece18 411 * case of synchronous execution, control returns after completion with a
demayer 0:6bf0743ece18 412 * value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 413 */
demayer 0:6bf0743ece18 414 int32_t (*Initialize)(ARM_Storage_Callback_t callback);
demayer 0:6bf0743ece18 415
demayer 0:6bf0743ece18 416 /**
demayer 0:6bf0743ece18 417 * \brief De-initialize the Storage Interface.
demayer 0:6bf0743ece18 418 *
demayer 0:6bf0743ece18 419 * The function Uninitialize() de-initializes the resources of Storage interface.
demayer 0:6bf0743ece18 420 *
demayer 0:6bf0743ece18 421 * It is called when the middleware component stops operation, and wishes to
demayer 0:6bf0743ece18 422 * release the software resources used by the interface.
demayer 0:6bf0743ece18 423 *
demayer 0:6bf0743ece18 424 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 425 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 426 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 427 *
demayer 0:6bf0743ece18 428 * @return If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 429 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 430 * future with a status value of ARM_DRIVER_OK or an error-code. In the
demayer 0:6bf0743ece18 431 * case of synchronous execution, control returns after completion with a
demayer 0:6bf0743ece18 432 * value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 433 */
demayer 0:6bf0743ece18 434 int32_t (*Uninitialize)(void);
demayer 0:6bf0743ece18 435
demayer 0:6bf0743ece18 436 /**
demayer 0:6bf0743ece18 437 * \brief Control the Storage interface power.
demayer 0:6bf0743ece18 438 *
demayer 0:6bf0743ece18 439 * The function \b ARM_Storage_PowerControl operates the power modes of the Storage interface.
demayer 0:6bf0743ece18 440 *
demayer 0:6bf0743ece18 441 * To start working with a peripheral the functions Initialize and PowerControl need to be called in this order:
demayer 0:6bf0743ece18 442 * drv->Initialize (...); // Allocate I/O pins
demayer 0:6bf0743ece18 443 * drv->PowerControl (ARM_POWER_FULL); // Power up peripheral, setup IRQ/DMA
demayer 0:6bf0743ece18 444 *
demayer 0:6bf0743ece18 445 * - Initialize() typically allocates the I/O resources (pins) for the
demayer 0:6bf0743ece18 446 * peripheral. The function can be called multiple times; if the I/O resources
demayer 0:6bf0743ece18 447 * are already initialized it performs no operation and just returns with
demayer 0:6bf0743ece18 448 * ARM_DRIVER_OK.
demayer 0:6bf0743ece18 449 *
demayer 0:6bf0743ece18 450 * - PowerControl (ARM_POWER_FULL) sets the peripheral registers including
demayer 0:6bf0743ece18 451 * interrupt (NVIC) and optionally DMA. The function can be called multiple
demayer 0:6bf0743ece18 452 * times; if the registers are already set it performs no operation and just
demayer 0:6bf0743ece18 453 * returns with ARM_DRIVER_OK.
demayer 0:6bf0743ece18 454 *
demayer 0:6bf0743ece18 455 * To stop working with a peripheral the functions PowerControl and Uninitialize need to be called in this order:
demayer 0:6bf0743ece18 456 *
demayer 0:6bf0743ece18 457 * drv->PowerControl (ARM_POWER_OFF); // Terminate any pending transfers, reset IRQ/DMA, power off peripheral
demayer 0:6bf0743ece18 458 * drv->Uninitialize (...); // Release I/O pins
demayer 0:6bf0743ece18 459 *
demayer 0:6bf0743ece18 460 * The functions PowerControl and Uninitialize always execute and can be used
demayer 0:6bf0743ece18 461 * to put the peripheral into a Safe State, for example after any data
demayer 0:6bf0743ece18 462 * transmission errors. To restart the peripheral in an error condition,
demayer 0:6bf0743ece18 463 * you should first execute the Stop Sequence and then the Start Sequence.
demayer 0:6bf0743ece18 464 *
demayer 0:6bf0743ece18 465 * @param state
demayer 0:6bf0743ece18 466 * \ref ARM_POWER_STATE. The target power-state for the storage controller.
demayer 0:6bf0743ece18 467 * The parameter state can have the following values:
demayer 0:6bf0743ece18 468 * - ARM_POWER_FULL : set-up peripheral for data transfers, enable interrupts
demayer 0:6bf0743ece18 469 * (NVIC) and optionally DMA. Can be called multiple times. If the peripheral
demayer 0:6bf0743ece18 470 * is already in this mode, then the function performs no operation and returns
demayer 0:6bf0743ece18 471 * with ARM_DRIVER_OK.
demayer 0:6bf0743ece18 472 * - ARM_POWER_LOW : may use power saving. Returns ARM_DRIVER_ERROR_UNSUPPORTED when not implemented.
demayer 0:6bf0743ece18 473 * - ARM_POWER_OFF : terminates any pending data transfers, disables peripheral, disables related interrupts and DMA.
demayer 0:6bf0743ece18 474 *
demayer 0:6bf0743ece18 475 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 476 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 477 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 478 *
demayer 0:6bf0743ece18 479 * @return If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 480 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 481 * future with a status value of ARM_DRIVER_OK or an error-code. In the
demayer 0:6bf0743ece18 482 * case of synchronous execution, control returns after completion with a
demayer 0:6bf0743ece18 483 * value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 484 */
demayer 0:6bf0743ece18 485 int32_t (*PowerControl)(ARM_POWER_STATE state);
demayer 0:6bf0743ece18 486
demayer 0:6bf0743ece18 487 /**
demayer 0:6bf0743ece18 488 * \brief read the contents of a given address range from the storage device.
demayer 0:6bf0743ece18 489 *
demayer 0:6bf0743ece18 490 * \details Read the contents of a range of storage memory into a buffer
demayer 0:6bf0743ece18 491 * supplied by the caller. The buffer is owned by the caller and should
demayer 0:6bf0743ece18 492 * remain accessible for the lifetime of this command.
demayer 0:6bf0743ece18 493 *
demayer 0:6bf0743ece18 494 * @param [in] addr
demayer 0:6bf0743ece18 495 * This specifies the address from where to read data.
demayer 0:6bf0743ece18 496 *
demayer 0:6bf0743ece18 497 * @param [out] data
demayer 0:6bf0743ece18 498 * The destination of the read operation. The buffer
demayer 0:6bf0743ece18 499 * is owned by the caller and should remain accessible for the
demayer 0:6bf0743ece18 500 * lifetime of this command.
demayer 0:6bf0743ece18 501 *
demayer 0:6bf0743ece18 502 * @param [in] size
demayer 0:6bf0743ece18 503 * The number of bytes requested to read. The data buffer
demayer 0:6bf0743ece18 504 * should be at least as large as this size.
demayer 0:6bf0743ece18 505 *
demayer 0:6bf0743ece18 506 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 507 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 508 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 509 *
demayer 0:6bf0743ece18 510 * @return If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 511 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 512 * future with the number of successfully transferred bytes passed in as
demayer 0:6bf0743ece18 513 * the 'status' parameter. In the case of synchronous execution, control
demayer 0:6bf0743ece18 514 * returns after completion with a positive transfer-count. Return values
demayer 0:6bf0743ece18 515 * less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 516 */
demayer 0:6bf0743ece18 517 int32_t (*ReadData)(uint64_t addr, void *data, uint32_t size);
demayer 0:6bf0743ece18 518
demayer 0:6bf0743ece18 519 /**
demayer 0:6bf0743ece18 520 * \brief program (write into) the contents of a given address range of the storage device.
demayer 0:6bf0743ece18 521 *
demayer 0:6bf0743ece18 522 * \details Write the contents of a given memory buffer into a range of
demayer 0:6bf0743ece18 523 * storage memory. In the case of flash memory, the destination range in
demayer 0:6bf0743ece18 524 * storage memory typically has its contents in an erased state from a
demayer 0:6bf0743ece18 525 * preceding erase operation. The source memory buffer is owned by the
demayer 0:6bf0743ece18 526 * caller and should remain accessible for the lifetime of this command.
demayer 0:6bf0743ece18 527 *
demayer 0:6bf0743ece18 528 * @param [in] addr
demayer 0:6bf0743ece18 529 * This is the start address of the range to be written into. It
demayer 0:6bf0743ece18 530 * needs to be aligned to the device's \em program_unit
demayer 0:6bf0743ece18 531 * specified in \ref ARM_STORAGE_INFO.
demayer 0:6bf0743ece18 532 *
demayer 0:6bf0743ece18 533 * @param [in] data
demayer 0:6bf0743ece18 534 * The source of the write operation. The buffer is owned by the
demayer 0:6bf0743ece18 535 * caller and should remain accessible for the lifetime of this
demayer 0:6bf0743ece18 536 * command.
demayer 0:6bf0743ece18 537 *
demayer 0:6bf0743ece18 538 * @param [in] size
demayer 0:6bf0743ece18 539 * The number of bytes requested to be written. The buffer
demayer 0:6bf0743ece18 540 * should be at least as large as this size. \note 'size' should
demayer 0:6bf0743ece18 541 * be a multiple of the device's 'program_unit' (see \ref
demayer 0:6bf0743ece18 542 * ARM_STORAGE_INFO).
demayer 0:6bf0743ece18 543 *
demayer 0:6bf0743ece18 544 * @note It is best for the middleware to write in units of
demayer 0:6bf0743ece18 545 * 'optimal_program_unit' (\ref ARM_STORAGE_INFO) of the device.
demayer 0:6bf0743ece18 546 *
demayer 0:6bf0743ece18 547 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 548 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 549 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 550 *
demayer 0:6bf0743ece18 551 * @return If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 552 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 553 * future with the number of successfully transferred bytes passed in as
demayer 0:6bf0743ece18 554 * the 'status' parameter. In the case of synchronous execution, control
demayer 0:6bf0743ece18 555 * returns after completion with a positive transfer-count. Return values
demayer 0:6bf0743ece18 556 * less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 557 */
demayer 0:6bf0743ece18 558 int32_t (*ProgramData)(uint64_t addr, const void *data, uint32_t size);
demayer 0:6bf0743ece18 559
demayer 0:6bf0743ece18 560 /**
demayer 0:6bf0743ece18 561 * @brief Erase Storage range.
demayer 0:6bf0743ece18 562 *
demayer 0:6bf0743ece18 563 * @details This function erases a range of storage specified by [addr, addr +
demayer 0:6bf0743ece18 564 * size). Both 'addr' and 'addr + size' should align with the
demayer 0:6bf0743ece18 565 * 'erase_unit'(s) of the respective owning storage block(s) (see \ref
demayer 0:6bf0743ece18 566 * ARM_STORAGE_BLOCK and \ref ARM_STORAGE_BLOCK_ATTRIBUTES). The range to
demayer 0:6bf0743ece18 567 * be erased will have its contents returned to the un-programmed state--
demayer 0:6bf0743ece18 568 * i.e. to 'erased_value' (see \ref ARM_STORAGE_BLOCK_ATTRIBUTES), which
demayer 0:6bf0743ece18 569 * is usually 1 to indicate the pattern of all ones: 0xFF.
demayer 0:6bf0743ece18 570 *
demayer 0:6bf0743ece18 571 * @param [in] addr
demayer 0:6bf0743ece18 572 * This is the start-address of the range to be erased. It must
demayer 0:6bf0743ece18 573 * start at an 'erase_unit' boundary of the underlying block.
demayer 0:6bf0743ece18 574 *
demayer 0:6bf0743ece18 575 * @param [in] size
demayer 0:6bf0743ece18 576 * Size (in bytes) of the range to be erased. 'addr + size'
demayer 0:6bf0743ece18 577 * must be aligned with the 'erase_unit' of the underlying
demayer 0:6bf0743ece18 578 * block.
demayer 0:6bf0743ece18 579 *
demayer 0:6bf0743ece18 580 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 581 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 582 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 583 *
demayer 0:6bf0743ece18 584 * @return
demayer 0:6bf0743ece18 585 * If the range to be erased doesn't align with the erase_units of the
demayer 0:6bf0743ece18 586 * respective start and end blocks, ARM_DRIVER_ERROR_PARAMETER is returned.
demayer 0:6bf0743ece18 587 * If any part of the range is protected, ARM_STORAGE_ERROR_PROTECTED is
demayer 0:6bf0743ece18 588 * returned. If any part of the range is not erasable,
demayer 0:6bf0743ece18 589 * ARM_STORAGE_ERROR_NOT_ERASABLE is returned. All such sanity-check
demayer 0:6bf0743ece18 590 * failures result in the error code being returned synchronously and the
demayer 0:6bf0743ece18 591 * storage bytes within the range remain unaffected.
demayer 0:6bf0743ece18 592 * Otherwise the function executes in the following ways:
demayer 0:6bf0743ece18 593 * If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 594 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 595 * future with the number of successfully erased bytes passed in as
demayer 0:6bf0743ece18 596 * the 'status' parameter. In the case of synchronous execution, control
demayer 0:6bf0743ece18 597 * returns after completion with a positive erase-count. Return values
demayer 0:6bf0743ece18 598 * less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 599 *
demayer 0:6bf0743ece18 600 * @note Erase() may return a smaller (positive) value than the size of the
demayer 0:6bf0743ece18 601 * requested range. The returned value indicates the actual number of bytes
demayer 0:6bf0743ece18 602 * erased. It is the caller's responsibility to follow up with an appropriate
demayer 0:6bf0743ece18 603 * request to complete the operation.
demayer 0:6bf0743ece18 604 *
demayer 0:6bf0743ece18 605 * @note in the case of a failed erase (except when
demayer 0:6bf0743ece18 606 * ARM_DRIVER_ERROR_PARAMETER, ARM_STORAGE_ERROR_PROTECTED, or
demayer 0:6bf0743ece18 607 * ARM_STORAGE_ERROR_NOT_ERASABLE is returned synchronously), the
demayer 0:6bf0743ece18 608 * requested range should be assumed to be in an unknown state. The
demayer 0:6bf0743ece18 609 * previous contents may not be retained.
demayer 0:6bf0743ece18 610 */
demayer 0:6bf0743ece18 611 int32_t (*Erase)(uint64_t addr, uint32_t size);
demayer 0:6bf0743ece18 612
demayer 0:6bf0743ece18 613 /**
demayer 0:6bf0743ece18 614 * @brief Erase complete storage. Optional function for faster erase of the complete device.
demayer 0:6bf0743ece18 615 *
demayer 0:6bf0743ece18 616 * This optional function erases the complete device. If the device does not
demayer 0:6bf0743ece18 617 * support global erase then the function returns the error value \ref
demayer 0:6bf0743ece18 618 * ARM_DRIVER_ERROR_UNSUPPORTED. The data field \em 'erase_all' = 1
demayer 0:6bf0743ece18 619 * of the structure \ref ARM_STORAGE_CAPABILITIES encodes that
demayer 0:6bf0743ece18 620 * ARM_STORAGE_EraseAll is supported.
demayer 0:6bf0743ece18 621 *
demayer 0:6bf0743ece18 622 * @note This API may execute asynchronously if
demayer 0:6bf0743ece18 623 * ARM_STORAGE_CAPABILITIES::asynchronous_ops is set. Asynchronous
demayer 0:6bf0743ece18 624 * execution is optional even if 'asynchronous_ops' is set.
demayer 0:6bf0743ece18 625 *
demayer 0:6bf0743ece18 626 * @return
demayer 0:6bf0743ece18 627 * If any part of the storage range is protected,
demayer 0:6bf0743ece18 628 * ARM_STORAGE_ERROR_PROTECTED is returned. If any part of the storage
demayer 0:6bf0743ece18 629 * range is not erasable, ARM_STORAGE_ERROR_NOT_ERASABLE is returned. All
demayer 0:6bf0743ece18 630 * such sanity-check failures result in the error code being returned
demayer 0:6bf0743ece18 631 * synchronously and the storage bytes within the range remain unaffected.
demayer 0:6bf0743ece18 632 * Otherwise the function executes in the following ways:
demayer 0:6bf0743ece18 633 * If asynchronous activity is launched, an invocation returns
demayer 0:6bf0743ece18 634 * ARM_DRIVER_OK, and the caller can expect to receive a callback in the
demayer 0:6bf0743ece18 635 * future with ARM_DRIVER_OK passed in as the 'status' parameter. In the
demayer 0:6bf0743ece18 636 * case of synchronous execution, control returns after completion with a
demayer 0:6bf0743ece18 637 * value of 1. Return values less than ARM_DRIVER_OK (0) signify errors.
demayer 0:6bf0743ece18 638 */
demayer 0:6bf0743ece18 639 int32_t (*EraseAll)(void);
demayer 0:6bf0743ece18 640
demayer 0:6bf0743ece18 641 /**
demayer 0:6bf0743ece18 642 * @brief Get the status of the current (or previous) command executed by the
demayer 0:6bf0743ece18 643 * storage controller; stored in the structure \ref ARM_STORAGE_STATUS.
demayer 0:6bf0743ece18 644 *
demayer 0:6bf0743ece18 645 * @return
demayer 0:6bf0743ece18 646 * The status of the underlying controller.
demayer 0:6bf0743ece18 647 *
demayer 0:6bf0743ece18 648 * @note This API returns synchronously--it does not result in an invocation
demayer 0:6bf0743ece18 649 * of a completion callback.
demayer 0:6bf0743ece18 650 */
demayer 0:6bf0743ece18 651 ARM_STORAGE_STATUS (*GetStatus)(void);
demayer 0:6bf0743ece18 652
demayer 0:6bf0743ece18 653 /**
demayer 0:6bf0743ece18 654 * @brief Get information about the Storage device; stored in the structure \ref ARM_STORAGE_INFO.
demayer 0:6bf0743ece18 655 *
demayer 0:6bf0743ece18 656 * @param [out] info
demayer 0:6bf0743ece18 657 * A caller-supplied buffer capable of being filled in with an
demayer 0:6bf0743ece18 658 * \ref ARM_STORAGE_INFO.
demayer 0:6bf0743ece18 659 *
demayer 0:6bf0743ece18 660 * @return ARM_DRIVER_OK if a ARM_STORAGE_INFO structure containing top level
demayer 0:6bf0743ece18 661 * metadata about the storage controller is filled into the supplied
demayer 0:6bf0743ece18 662 * buffer, else an appropriate error value.
demayer 0:6bf0743ece18 663 *
demayer 0:6bf0743ece18 664 * @note It is the caller's responsibility to ensure that the buffer passed in
demayer 0:6bf0743ece18 665 * is able to be initialized with a \ref ARM_STORAGE_INFO.
demayer 0:6bf0743ece18 666 *
demayer 0:6bf0743ece18 667 * @note This API returns synchronously--it does not result in an invocation
demayer 0:6bf0743ece18 668 * of a completion callback.
demayer 0:6bf0743ece18 669 */
demayer 0:6bf0743ece18 670 int32_t (*GetInfo)(ARM_STORAGE_INFO *info);
demayer 0:6bf0743ece18 671
demayer 0:6bf0743ece18 672 /**
demayer 0:6bf0743ece18 673 * \brief For memory-mapped storage, resolve an address relative to
demayer 0:6bf0743ece18 674 * the storage controller into a memory address.
demayer 0:6bf0743ece18 675 *
demayer 0:6bf0743ece18 676 * @param addr
demayer 0:6bf0743ece18 677 * This is the address for which we want a resolution to the
demayer 0:6bf0743ece18 678 * processor's physical address space. It is an offset from the
demayer 0:6bf0743ece18 679 * start of the storage map maintained by the owning storage
demayer 0:6bf0743ece18 680 * controller.
demayer 0:6bf0743ece18 681 *
demayer 0:6bf0743ece18 682 * @return
demayer 0:6bf0743ece18 683 * The resolved address in the processor's address space; else
demayer 0:6bf0743ece18 684 * ARM_STORAGE_INVALID_ADDRESS, if no resolution is possible.
demayer 0:6bf0743ece18 685 *
demayer 0:6bf0743ece18 686 * @note This API returns synchronously. The invocation should return quickly,
demayer 0:6bf0743ece18 687 * and result in a resolved address.
demayer 0:6bf0743ece18 688 */
demayer 0:6bf0743ece18 689 uint32_t (*ResolveAddress)(uint64_t addr);
demayer 0:6bf0743ece18 690
demayer 0:6bf0743ece18 691 /**
demayer 0:6bf0743ece18 692 * @brief Advance to the successor of the current block (iterator), or fetch
demayer 0:6bf0743ece18 693 * the first block (if 'prev_block' is passed in as NULL).
demayer 0:6bf0743ece18 694 *
demayer 0:6bf0743ece18 695 * @details This helper function fetches (an iterator to) the next block (or
demayer 0:6bf0743ece18 696 * the first block if 'prev_block' is passed in as NULL). In the failure
demayer 0:6bf0743ece18 697 * case, a terminating, invalid block iterator is filled into the out
demayer 0:6bf0743ece18 698 * parameter: 'next_block'. In combination with \ref
demayer 0:6bf0743ece18 699 * ARM_STORAGE_VALID_BLOCK(), it can be used to iterate over the sequence
demayer 0:6bf0743ece18 700 * of blocks within the storage map:
demayer 0:6bf0743ece18 701 *
demayer 0:6bf0743ece18 702 * \code
demayer 0:6bf0743ece18 703 * ARM_STORAGE_BLOCK block;
demayer 0:6bf0743ece18 704 * for (drv->GetNextBlock(NULL, &block); ARM_STORAGE_VALID_BLOCK(&block); drv->GetNextBlock(&block, &block)) {
demayer 0:6bf0743ece18 705 * // make use of block
demayer 0:6bf0743ece18 706 * }
demayer 0:6bf0743ece18 707 * \endcode
demayer 0:6bf0743ece18 708 *
demayer 0:6bf0743ece18 709 * @param[in] prev_block
demayer 0:6bf0743ece18 710 * An existing block (iterator) within the same storage
demayer 0:6bf0743ece18 711 * controller. The memory buffer holding this block is owned
demayer 0:6bf0743ece18 712 * by the caller. This pointer may be NULL; if so, the
demayer 0:6bf0743ece18 713 * invocation fills in the first block into the out parameter:
demayer 0:6bf0743ece18 714 * 'next_block'.
demayer 0:6bf0743ece18 715 *
demayer 0:6bf0743ece18 716 * @param[out] next_block
demayer 0:6bf0743ece18 717 * A caller-owned buffer large enough to be filled in with
demayer 0:6bf0743ece18 718 * the following ARM_STORAGE_BLOCK. It is legal to provide the
demayer 0:6bf0743ece18 719 * same buffer using 'next_block' as was passed in with 'prev_block'. It
demayer 0:6bf0743ece18 720 * is also legal to pass a NULL into this parameter if the
demayer 0:6bf0743ece18 721 * caller isn't interested in populating a buffer with the next
demayer 0:6bf0743ece18 722 * block--i.e. if the caller only wishes to establish the
demayer 0:6bf0743ece18 723 * presence of a next block.
demayer 0:6bf0743ece18 724 *
demayer 0:6bf0743ece18 725 * @return ARM_DRIVER_OK if a valid next block is found (or first block, if
demayer 0:6bf0743ece18 726 * prev_block is passed as NULL); upon successful operation, the contents
demayer 0:6bf0743ece18 727 * of the next (or first) block are filled into the buffer pointed to by
demayer 0:6bf0743ece18 728 * the parameter 'next_block' and ARM_STORAGE_VALID_BLOCK(next_block) is
demayer 0:6bf0743ece18 729 * guaranteed to be true. Upon reaching the end of the sequence of blocks
demayer 0:6bf0743ece18 730 * (iterators), or in case the driver is unable to fetch information about
demayer 0:6bf0743ece18 731 * the next (or first) block, an error (negative) value is returned and an
demayer 0:6bf0743ece18 732 * invalid StorageBlock is populated into the supplied buffer. If
demayer 0:6bf0743ece18 733 * prev_block is NULL, the first block is returned.
demayer 0:6bf0743ece18 734 *
demayer 0:6bf0743ece18 735 * @note This API returns synchronously--it does not result in an invocation
demayer 0:6bf0743ece18 736 * of a completion callback.
demayer 0:6bf0743ece18 737 */
demayer 0:6bf0743ece18 738 int32_t (*GetNextBlock)(const ARM_STORAGE_BLOCK* prev_block, ARM_STORAGE_BLOCK *next_block);
demayer 0:6bf0743ece18 739
demayer 0:6bf0743ece18 740 /**
demayer 0:6bf0743ece18 741 * @brief Find the storage block (iterator) encompassing a given storage address.
demayer 0:6bf0743ece18 742 *
demayer 0:6bf0743ece18 743 * @param[in] addr
demayer 0:6bf0743ece18 744 * Storage address in bytes.
demayer 0:6bf0743ece18 745 *
demayer 0:6bf0743ece18 746 * @param[out] block
demayer 0:6bf0743ece18 747 * A caller-owned buffer large enough to be filled in with the
demayer 0:6bf0743ece18 748 * ARM_STORAGE_BLOCK encapsulating the given address. This value
demayer 0:6bf0743ece18 749 * can also be passed in as NULL if the caller isn't interested
demayer 0:6bf0743ece18 750 * in populating a buffer with the block--if the caller only
demayer 0:6bf0743ece18 751 * wishes to establish the presence of a containing storage
demayer 0:6bf0743ece18 752 * block.
demayer 0:6bf0743ece18 753 *
demayer 0:6bf0743ece18 754 * @return ARM_DRIVER_OK if a containing storage-block is found. In this case,
demayer 0:6bf0743ece18 755 * if block is non-NULL, the buffer pointed to by it is populated with
demayer 0:6bf0743ece18 756 * the contents of the storage block--i.e. if block is valid and a block is
demayer 0:6bf0743ece18 757 * found, ARM_STORAGE_VALID_BLOCK(block) would return true following this
demayer 0:6bf0743ece18 758 * call. If there is no storage block containing the given offset, or in
demayer 0:6bf0743ece18 759 * case the driver is unable to resolve an address to a storage-block, an
demayer 0:6bf0743ece18 760 * error (negative) value is returned and an invalid StorageBlock is
demayer 0:6bf0743ece18 761 * populated into the supplied buffer.
demayer 0:6bf0743ece18 762 *
demayer 0:6bf0743ece18 763 * @note This API returns synchronously--it does not result in an invocation
demayer 0:6bf0743ece18 764 * of a completion callback.
demayer 0:6bf0743ece18 765 */
demayer 0:6bf0743ece18 766 int32_t (*GetBlock)(uint64_t addr, ARM_STORAGE_BLOCK *block);
demayer 0:6bf0743ece18 767 } const ARM_DRIVER_STORAGE;
demayer 0:6bf0743ece18 768
demayer 0:6bf0743ece18 769 #ifdef __cplusplus
demayer 0:6bf0743ece18 770 }
demayer 0:6bf0743ece18 771 #endif // __cplusplus
demayer 0:6bf0743ece18 772
demayer 0:6bf0743ece18 773 #endif /* __DRIVER_STORAGE_H */
demayer 0:6bf0743ece18 774
demayer 0:6bf0743ece18 775 /** @}*/