erkin yucel / mbed-os

mbed os with nrf51 internal bandgap enabled to read battery level

Dependents:   BLE_file_test BLE_Blink ExternalEncoder

hal/storage_abstraction/Driver_Storage.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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