Gordon Craig / mbed-dev

Forked.

Fork of mbed-dev by mbed official

hal/storage_abstraction/Driver_Storage.h@149:156823d33999, 2016-10-28 (annotated)

Committer:
<>
Date:
Fri Oct 28 11:17:30 2016 +0100
Revision:
149:156823d33999
Parent:
144:ef7eb2e8f9f7
Child:
167:e84263d55307
This updates the lib to the mbed lib v128



NOTE: This release includes a restructuring of the file and directory locations and thus some

include paths in your code may need updating accordingly.

Who changed what in which revision?

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