Verified Commit bcf5d9d7 authored by Vincent Coubard's avatar Vincent Coubard
Browse files

Initial commit


Signed-off-by: Vincent Coubard's avatarVincent Coubard <vincent.coubard@arm.com>
parents
# List of files and extensions to be ignored
# Eclipse
*.project
*.cproject
.pydevproject
.settings/
# Visual Studio Code
.vscode/
# Garbage files
build*/
cmake_build*/
*.orig
**/__pycache__
*.pyc
Objects/
RTE/
# TF-Fuzz build artifacts
*.o
*_grammar.*
tfz
**/.vscode
**/ota_build
**/cmake-build-debug
**/.idea
[submodule "source/lib/amazon_freertos"]
path = lib/amazon_freertos
url = https://github.com/aws/amazon-freertos.git
[submodule "source/lib/mbedcrypto"]
path = lib/mbedcrypto
url = https://github.com/ARMmbed/mbedtls.git
[submodule "source/lib/mcuboot"]
path = lib/mcuboot
url = https://github.com/mcu-tools/mcuboot.git
[submodule "source/lib/tf-m"]
path = lib/tf-m
url = https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git
[submodule "source/lib/tfm_test"]
path = lib/tfm_test
url = https://git.trustedfirmware.org/TF-M/tf-m-tests.git
[submodule "source/lib/VHT"]
path = lib/VHT
url = https://github.com/ARM-software/VHT
[submodule "source/lib/ml-embedded-evaluation-kit"]
path = lib/ml-embedded-evaluation-kit
url = https://review.mlplatform.org/ml/ethos-u/ml-embedded-evaluation-kit
Unless specifically indicated otherwise in a file, files are licensed under the Apache 2.0 license,
as can be found in: LICENSE-apache-2.0.txt
Folders containing files under different permissive license than Apache 2.0 are listed below. Each folder should contain its own README file with license specified for its files. The original license text is included in those source files.
- [lib/amazon_freertos](lib/amazon_freertos) - MIT
- [lib/mbedcrypto](lib/mbedcrypto) - Apache-2.0
- [lib/mcuboot](lib/mcuboot) - Apache-2.0
- [lib/ml-embedded-evaluation-kit](lib/ml-embedded-evaluation-kit) - Apache-2.0
- [lib/tf-m](lib/tf-m) - BSD-3-Clause
- [lib/tfm_test](lib/tfm_test) - BSD-3-Clause
- [lib/VHT](source/lib/VHT) - Apache-2.0
- [tinycbor](kws/ota/ota_for_aws/source/dependency/3rdparty/tinycbor) - MIT License
- [coreJSON](kws/ota/ota_for_aws/source/dependency/coreJSON) - MIT License
- [tfm test service](bsp/test_services) - BSD-3-Clause
- [tfm secure fw](bsp/secure_fw) - BSD-3-Clause
- [tfm interface](bsp/interface) - BSD-3-Clause
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
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.
# Introduction
[Arm IoT Total Solutions](https://confluence.arm.com/www.arm.com/solutions/iot/total-solutions-iot) provides a complete solution designed for specific use-cases, leaving developers to focus on what really matters – innovation and differentiation across diverse and varied use cases. It has everything needed to simplify the design process and streamline product development, including hardware IP, software, real-time OS support, machine learning (ML) models, advanced tools such as the new Virtual Hardware Targets, application specific reference code and support from the world’s largest IoT ecosystem.
# Configurations
This repo contains Arm's first [IoT Total Solution](https://confluence.arm.com/www.arm.com/solutions/iot/total-solutions-iot), "Keyword Detection". It provides general-purpose compute and ML workload use-cases, including an ML-based keyword recognition example that leverages the DS-CNN model from the [Arm Model Zoo](https://github.com/ARM-software/ML-zoo). The software supports multiple configurations of the Arm Corstone™-300 subsystem, incorporating the Cortex-M55 processor and Arm Ethos™-U55 microNPU. This total solution provides the complex, non differentiated secure platform software on behalf of the ecosystem, thus enabling you to focus on your next killer app. This repo also supports a GitHub runner ci/cd workflow right out of the box which leverages [Arm Virtual Hardware](https://www.arm.com/products/development-tools/simulation/virtual-hardware), a simulation environment that enables software development without the need of physical SoCs. The source code in this repo supports several configurations of the software, all of which are AWS IoT Core (OTA, etc.) enabled right out of the box. Instructions for using non-default configurations are provided in the below table.
| # | default | description | .github/workflows/build.yml code change | |
|---|---------|----------------------------------------------------------------------------------------------------------|-----------------------------------------|---|
| 1 | | general purpose compute application (blinky application running on the m55 processor only) | tbd | |
| 2 | | keyword detection application (running on the m55 only) | tbd | |
| 3 | YES | keyword detection application (running on the m55+u55) | tbd | |
| 4 | | instructions for replacing the keyword model and application code with your own custom application/model | tbd | |
# Quick Start
Follow these simple steps to use this code example's default configuration #3 keyword detection application.
1. Mirror this repo
```sh
# create a mirror (assumes new repo is already created https://docs.github.com/en/articles/creating-a-new-repository)
> git clone --bare https://github.com/ARM-software/ATS-Keyword
> cd ATS-Keyword
> git push --mirror https://github.com/exampleuser/my-ats-keyword.git
# clone your new repo
> git clone https://github.com/exampleuser/my-ats-keyword.git
# optionally remove the original repo from your hard drive
> cd ..
> rm -rf ATS-Keyword
```
2. Launch Arm Virtual Hardware Instance
```sh
# TBD
```
3. Launch GitHub Self-Hosted Runner
```sh
# follow your repo's instructions to configure the github self hosted runner on the Arm Virtual Hardware ec2 instance
# https://github.com/exampleuser/my-ats-keyword.git/settings/actions/runners/new
# Login to the ami
> ssh ubuntu@<your-ec2-instance>
# Install runner software
> mkdir actions-runner && cd actions-runner
> curl -o actions-runner-osx-x64-2.283.2.tar.gz -L https://github.com/actions/runner/releases/download/v2.283.2/actions-runner-osx-x64-2.283.2.tar.gz
> echo "d7d026b9bf1cb3f133cf53e79c71c0458a82b3f2bdb0a8859cd386ae18ee7c4a actions-runner-osx-x64-2.283.2.tar.gz" | shasum -a 256 -c
> tar xzf ./actions-runner-osx-x64-2.283.2.tar.gz
# Create, configure and run the runner
> ./config.sh --url https://github.com/exampleuser/my-ats-keyword --token <token>
> ./run.sh
# exit the ami and return shell back to your desktop
> exit
```
4. make a trivial (whitespace) code change and watch the code example compile and run test cases on Arm Virtual Hardware on your ec2 instance
```sh
# add whitespace to this file
> vi .github/workflows/build.yml
# git push it
> git add .github/workflows/build.yml
> git commit -m "initial arm virtual hardware github runner test"
> git push origin master
```
# Replace DS-CNN
```sh
# pseudo cli/commands/steps to replace the keyword model with another model
# example can use a model from the arm model zoo
# steps should be validated by arm prior to release
```
# ML Embedded Eval Kit
Philip Lewer to replace this text with a paragraph for ml embedded eval kit
# Future Enhancements
- [AWS Partner Device Catalog Listing](https://devices.amazonaws.com/) (leveraging Arm Virtual Hardware)
- cmake
# Other Resources
| Repository | Description | | | |
|---------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|---|---|
| [Arm AI Ecosystem Catalog](https://www.arm.com/why-arm/partner-ecosystem/ai-ecosystem-catalog) | Connects you to the right partners, enabling you to build the next generation of AI solutions | | | |
| [Arm ML Model Zoo](https://github.com/ARM-software/ML-zoo) | A collection of machine learning models optimized for Arm IP. | | | |
| [Arm Virtual Hardware Documentation](https://mdk-packs.github.io/VHT-TFLmicrospeech/overview/html/index.html) | Documentation for [Arm Virtual Hardware](https://www.arm.com/products/development-tools/simulation/virtual-hardware) | | | |
| Support | A [community.arm.com](http://community.arm.com/) forum exists for users to post queries. INTERNAL NOTE → they have – already set up on the test environment (link). This will be moved to the live environment on 19th October. | | | |
# License and contributions
The software is provided under the Apache-2.0 license. All contributions to software and documents are licensed by contributors under the same license model as the software/document itself (ie. inbound == outbound licensing). ATS-Keyword may reuse software already licensed under another license, provided the license is permissive in nature and compatible with Apache v2.0.
Folders containing files under different permissive license than Apache 2.0 are listed in the LICENSE file.
\ No newline at end of file
/*
* Copyright (c) 2021 Arm Limited
*
* 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 "stdio.h"
#include "FreeRTOS.h"
#include "semphr.h"
#include "task.h"
#include "queue.h"
#include "timers.h"
#include "tfm_ns_interface.h"
#include "psa/protected_storage.h"
#include "serial.h"
#include "blink_task.h"
#include "ml_interface.h"
enum {
LED1 = 1 << 0,
LED_YES = LED1,
LED2 = 1 << 1,
LED_GO = LED2,
LED3 = 1 << 2,
LED_UP = LED3,
LED4 = 1 << 3,
LED_LEFT = LED4,
LED5 = 1 << 4,
LED_ON = LED5,
LED6 = 1 << 5,
LED_ALIVE = LED6,
LED7 = 1 << 6,
LED8 = 1 << 7,
LED9 = 1 << 8,
LED10 = 1 << 9,
LED_ALL = 0xFF
};
static uint32_t *fpgaio_leds = (uint32_t *)0x49302000;
// Events
typedef enum {
UI_EVENT_BLINK,
UI_EVENT_ML_STATE_CHANGE
} ui_state_event_t;
typedef struct {
ui_state_event_t event;
} ui_msg_t;
static ui_msg_t blink_event = {
UI_EVENT_BLINK
};
static ui_msg_t ml_state_change_event = {
UI_EVENT_ML_STATE_CHANGE
};
// Message queue
static QueueHandle_t ui_msg_queue = NULL;
// Blinking timer
TimerHandle_t blink_timer;
void led_on(uint8_t bits)
{
*fpgaio_leds |= bits;
}
void led_off(uint8_t bits)
{
*fpgaio_leds &= ~bits;
}
void led_toggle(uint8_t bits)
{
*fpgaio_leds ^= bits;
}
static void blink_timer_cb( TimerHandle_t xTimer ) {
// Schedule blink of the led in the event queue
xQueueSend(ui_msg_queue, (void*) &blink_event, 0);
}
/*
* Blink task.
*
* Blinks LEDs.
*
* LED1 on and LED2 off => heard YES
* LED1 off and LED2 off => heard NO
* LED1 off and LED2 blinking => no/unknown input
*/
void blink_task(void *pvParameters)
{
printf("Blink task started\r\n");
// Create the ui event queue
ui_msg_queue = xQueueCreate(
10, // In practive at most two items (blink and ml state change) should be in the queue.
sizeof(ui_msg_t)
);
// Configure the timer
blink_timer = xTimerCreate(
"Blink Timer",
portTICK_PERIOD_MS * 25, // timeout
pdTRUE, // auto reload
( void * ) 0, // initial value
blink_timer_cb
);
// Setup blinking event
led_off(LED_ALL);
// start the blinking timer
xTimerStart(blink_timer, portMAX_DELAY);
while (1) {
ui_msg_t msg;
if(xQueueReceive(ui_msg_queue, &msg, portMAX_DELAY) != pdPASS ) {
continue;
}
switch (msg.event)
{
case UI_EVENT_BLINK:
led_toggle(LED_ALL);
break;
default:
break;
}
}
}
/*
* Copyright (c) 2021 Arm Limited
*
* 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 "FreeRTOS.h"
#include "task.h"
void vApplicationStackOverflowHook( TaskHandle_t xTask, char * pcTaskName )
{
printf("ERROR: Stack Overflow in task: %s", pcTaskName);
while(1);
}
/* configUSE_STATIC_ALLOCATION is set to 1, so the application must provide an
implementation of vApplicationGetIdleTaskMemory() to provide the memory that is
used by the Idle task. */
void vApplicationGetIdleTaskMemory( StaticTask_t **ppxIdleTaskTCBBuffer, StackType_t **ppxIdleTaskStackBuffer, uint32_t *pulIdleTaskStackSize )
{
/* If the buffers to be provided to the Idle task are declared inside this
function then they must be declared static - otherwise they will be allocated on
the stack and so not exists after this function exits. */
static StaticTask_t xIdleTaskTCB;
static StackType_t uxIdleTaskStack[ configMINIMAL_STACK_SIZE ];
/* Pass out a pointer to the StaticTask_t structure in which the Idle task's
state will be stored. */
*ppxIdleTaskTCBBuffer = &xIdleTaskTCB;
/* Pass out the array that will be used as the Idle task's stack. */
*ppxIdleTaskStackBuffer = uxIdleTaskStack;
/* Pass out the size of the array pointed to by *ppxIdleTaskStackBuffer.
Note that, as the array is necessarily of type StackType_t,
configMINIMAL_STACK_SIZE is specified in words, not bytes. */
*pulIdleTaskStackSize = configMINIMAL_STACK_SIZE;
}
/*-----------------------------------------------------------*/
/* configUSE_STATIC_ALLOCATION and configUSE_TIMERS are both set to 1, so the
application must provide an implementation of vApplicationGetTimerTaskMemory()
to provide the memory that is used by the Timer service task. */
void vApplicationGetTimerTaskMemory( StaticTask_t **ppxTimerTaskTCBBuffer, StackType_t **ppxTimerTaskStackBuffer, uint32_t *pulTimerTaskStackSize )
{
/* If the buffers to be provided to the Timer task are declared inside this
function then they must be declared static - otherwise they will be allocated on
the stack and so not exists after this function exits. */
static StaticTask_t xTimerTaskTCB;
static StackType_t uxTimerTaskStack[ configTIMER_TASK_STACK_DEPTH ];
/* Pass out a pointer to the StaticTask_t structure in which the Timer
task's state will be stored. */
*ppxTimerTaskTCBBuffer = &xTimerTaskTCB;
/* Pass out the array that will be used as the Timer task's stack. */
*ppxTimerTaskStackBuffer = uxTimerTaskStack;
/* Pass out the size of the array pointed to by *ppxTimerTaskStackBuffer.
Note that, as the array is necessarily of type StackType_t,
configMINIMAL_STACK_SIZE is specified in words, not bytes. */
*pulTimerTaskStackSize = configTIMER_TASK_STACK_DEPTH;
}
/*
* Copyright (c) 2017-2021 Arm Limited
*
* 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 "stdio.h"
#include "string.h"
#include "cmsis.h"
#include "serial.h"
#include "print_log.h"
#include "blink_task.h"
#include "ml_interface.h"
#include "FreeRTOS.h"
#include "task.h"
#include "FreeRTOS_IP.h"
/* includes for TFM */
#include "tfm_ns_interface.h"
#include "psa/protected_storage.h"
#include "psa/crypto.h"
/* includes for IoT Cloud */
#include "iot_mqtt.h"