From 9f95ff5b6ba01db09552b84a0ab79607060a2666 Mon Sep 17 00:00:00 2001 From: Ali Labbene Date: Wed, 11 Dec 2019 08:59:21 +0100 Subject: Official ARM version: v5.4.0 Add CMSIS V5.4.0, please refer to index.html available under \docs folder. Note: content of \CMSIS\Core\Include has been copied under \Include to keep the same structure used in existing projects, and thus avoid projects mass update Note: the following components have been removed from ARM original delivery (as not used in ST packages) - CMSIS_EW2018.pdf - .gitattributes - .gitignore - \Device - \CMSIS - \CoreValidation - \DAP - \Documentation - \DoxyGen - \Driver - \Pack - \RTOS\CMSIS_RTOS_Tutorial.pdf - \RTOS\RTX - \RTOS\Template - \RTOS2\RTX - \Utilities - All ARM/GCC projects files are deleted from \DSP, \RTOS and \RTOS2 Change-Id: Ia026c3f0f0d016627a4fb5a9032852c33d24b4d3 --- .../html/group__SampleUseOfStorageDriver.html | 279 +++++++++++++++++++++ 1 file changed, 279 insertions(+) create mode 100644 docs/Driver/html/group__SampleUseOfStorageDriver.html (limited to 'docs/Driver/html/group__SampleUseOfStorageDriver.html') diff --git a/docs/Driver/html/group__SampleUseOfStorageDriver.html b/docs/Driver/html/group__SampleUseOfStorageDriver.html new file mode 100644 index 0000000..5761485 --- /dev/null +++ b/docs/Driver/html/group__SampleUseOfStorageDriver.html @@ -0,0 +1,279 @@ + + + + + +Sample Use of Storage Driver +CMSIS-Driver: Sample Use of Storage Driver + + + + + + + + + + + + + + +
+
+ + + + + + + +
+
CMSIS-Driver +  Version 2.6.0 +
+
Peripheral Interface for Middleware and Application Code
+
+
+ +
+
    + +
+
+ + + +
+
+ +
+
+
+ +
+ + + + +
+ +
+ +
+
+
Sample Use of Storage Driver
Storage Interface
+
+
+

Example Code:

+

The following is a generic algorithm to erase and program one ARM_STORAGE_BLOCK_ATTRIBUTES::erase_unit worth of storage and then read it back to be verified. It handles both synchronous and asynchronous driver implementations.

+
// Copyright (c) 2006-2016, Arm Limited, All Rights Reserved
+
// SPDX-License-Identifier: Apache-2.0
+
//
+
// Licensed under the Apache License, Version 2.0 (the "License"); you may
+
// not use this file except in compliance with the License.
+
// You may obtain a copy of the License at
+
//
+
// http:// www.apache.org/licenses/LICENSE-2.0
+
//
+
// Unless required by applicable law or agreed to in writing, software
+
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+
// See the License for the specific language governing permissions and
+
// limitations under the License.
+
+
#include "Driver_Storage.h"
+
#include <stdio.h>
+
#include <string.h>
+
+
#define TEST_ASSERT(Expr) if (!(Expr)) { printf("%s:%u: assertion failure\n", __FUNCTION__, __LINE__); while (1) ;}
+
#define TEST_ASSERT_EQUAL(expected, actual) if ((expected) != (actual)) {printf("%s:%u: assertion failure\n", __FUNCTION__, __LINE__); while (1) ;}
+
#define TEST_ASSERT_NOT_EQUAL(expected, actual) if ((expected) == (actual)) {printf("%s:%u: assertion failure\n", __FUNCTION__, __LINE__); while (1) ;}
+
+
// forward declarations
+
void callbackHandler(int32_t status, ARM_STORAGE_OPERATION operation);
+
void progressStateMachine(void);
+
+
static enum {
+
NEEDS_INITIALIZATION,
+
NEEDS_ERASE,
+
NEEDS_PROGRAMMING,
+
NEEDS_READ,
+
NEEDS_VERIFICATION_FOLLOWING_READ,
+
FINISHED
+
} state;
+
+
extern ARM_DRIVER_STORAGE ARM_Driver_Storage_(0);
+
ARM_DRIVER_STORAGE *drv = &ARM_Driver_Storage_(0);
+
+
static const unsigned BUFFER_SIZE = 16384;
+
static uint8_t buffer[BUFFER_SIZE];
+
+
void main(int argc __unused, char** argv __unused)
+
{
+
state = NEEDS_INITIALIZATION;
+
+
progressStateMachine();
+
while (true) {
+
// WFE(); // optional low-power sleep
+
}
+
}
+
+
void progressStateMachine(void)
+
{
+
int32_t rc;
+
+
static ARM_STORAGE_BLOCK firstBlock;
+
if (!ARM_STORAGE_VALID_BLOCK(&firstBlock)) {
+
// Get the first block. This block is entered only once.
+
rc = drv->GetNextBlock(NULL, &firstBlock); // get first block
+
TEST_ASSERT_EQUAL(ARM_DRIVER_OK, rc);
+
}
+
TEST_ASSERT(ARM_STORAGE_VALID_BLOCK(&firstBlock));
+
TEST_ASSERT(firstBlock.size > 0);
+
+
switch (state) {
+
case NEEDS_INITIALIZATION:
+
rc = drv->Initialize(callbackHandler);
+
TEST_ASSERT(rc >= ARM_DRIVER_OK);
+
if (rc == ARM_DRIVER_OK) {
+
TEST_ASSERT_EQUAL(1, drv->GetCapabilities().asynchronous_ops);
+
state = NEEDS_ERASE;
+
return; // there is pending asynchronous activity which will lead to a completion callback later.
+
}
+
TEST_ASSERT_EQUAL(1, rc); // synchronous completion
+
+
// intentional fall-through
+
+
case NEEDS_ERASE:
+
TEST_ASSERT(firstBlock.attributes.erase_unit > 0);
+
rc = drv->Erase(firstBlock.addr, firstBlock.attributes.erase_unit);
+
TEST_ASSERT(rc >= ARM_DRIVER_OK);
+
if (rc == ARM_DRIVER_OK) {
+
TEST_ASSERT_EQUAL(1, drv->GetCapabilities().asynchronous_ops);
+
state = NEEDS_PROGRAMMING;
+
return; // there is pending asynchronous activity which will lead to a completion callback later.
+
}
+
TEST_ASSERT_EQUAL(firstBlock.attributes.erase_unit, (uint32_t)rc); // synchronous completion
+
+
// intentional fall-through
+
+
case NEEDS_PROGRAMMING:
+
TEST_ASSERT(BUFFER_SIZE >= firstBlock.attributes.erase_unit);
+
#define PATTERN 0xAA
+
memset(buffer, PATTERN, firstBlock.attributes.erase_unit);
+
rc = drv->ProgramData(firstBlock.addr, buffer, firstBlock.attributes.erase_unit);
+
TEST_ASSERT(rc >= ARM_DRIVER_OK);
+
if (rc == ARM_DRIVER_OK) {
+
TEST_ASSERT_EQUAL(1, drv->GetCapabilities().asynchronous_ops);
+
state = NEEDS_READ;
+
return; // there is pending asynchronous activity which will lead to a completion callback later.
+
}
+
TEST_ASSERT_EQUAL(firstBlock.attributes.erase_unit, (uint32_t)rc); // synchronous completion
+
+
// intentional fall-through
+
+
case NEEDS_READ:
+
rc = drv->ReadData(firstBlock.addr, buffer, firstBlock.attributes.erase_unit);
+
TEST_ASSERT(rc >= ARM_DRIVER_OK);
+
if (rc == ARM_DRIVER_OK) {
+
TEST_ASSERT_EQUAL(1, drv->GetCapabilities().asynchronous_ops);
+
state = NEEDS_VERIFICATION_FOLLOWING_READ;
+
return; // there is pending asynchronous activity which will lead to a completion callback later.
+
}
+
TEST_ASSERT_EQUAL(firstBlock.attributes.erase_unit, (uint32_t)rc);
+
+
// intentional fall-through
+
+
case NEEDS_VERIFICATION_FOLLOWING_READ:
+
printf("verifying data\r\n");
+
for (unsigned i = 0; i < firstBlock.attributes.erase_unit; i++) {
+
TEST_ASSERT_EQUAL(PATTERN, buffer[i]);
+
}
+
state = FINISHED;
+
printf("done\r\n");
+
break;
+
+
case FINISHED:
+
break;
+
} // switch (state)
+
}
+
+
void callbackHandler(int32_t status, ARM_STORAGE_OPERATION operation)
+
{
+
(void)status;
+
(void)operation;
+
switch (operation) {
+
case ARM_STORAGE_OPERATION_INITIALIZE:
+
case ARM_STORAGE_OPERATION_READ_DATA:
+
case ARM_STORAGE_OPERATION_PROGRAM_DATA:
+
case ARM_STORAGE_OPERATION_ERASE:
+
progressStateMachine();
+
break;
+
+
default:
+
printf("callbackHandler: unexpected callback for opcode %u with status %ld\r\n", operation, status);
+
break;
+
}
+
}
+
+
+ + + + -- cgit