README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65

# Arm Ethos-U Core Driver

This repository contains a device driver for the Arm Ethos-U NPU.

## Building

The source code comes with a CMake based build system. The driver is expeced
to be cross compiled for any of the supported Arm Cortex-m CPUs, which will
require the user to setup a custom toolchain file.

The user is also required to define `CMAKE_SYSTEM_PROCESSOR` for the target CPU,
for example cortex-m55+nodsp+nofp. This can be done either in the toolchain
file or on the command line.

```
$ mkdir build
$ cd build
$ cmake .. -DCMAKE_TOOLCHAIN_FILE=<toolchain> -DCMAKE_SYSTEM_PROCESSOR=cortex-m<nr><features>
$ make
```

# License

The Arm Ethos-U core driver is proved under an Apache-2.0 license. Please see
[LICENSE.txt](LICENSE.txt) for more information.

# Contributions

The Arm Ethos-U project welcomes contributions under the Apache-2.0 license.

Before we can accept your contribution, you need to certify its origin and give
us your permission. For this process we use the Developer Certificate of Origin
(DCO) V1.1 (https://developercertificate.org).

To indicate that you agree to the terms of the DCO, you "sign off" your
contribution by adding a line with your name and e-mail address to every git
commit message. You must use your real name, no pseudonyms or anonymous
contributions are accepted. If there are more than one contributor, everyone
adds their name and e-mail to the commit message.

```
Author: John Doe \<john.doe@example.org\>
Date:   Mon Feb 29 12:12:12 2016 +0000

Title of the commit

Short description of the change.
   
Signed-off-by: John Doe john.doe@example.org
Signed-off-by: Foo Bar foo.bar@example.org
```

The contributions will be code reviewed by Arm before they can be accepted into
the repository.

# Security

If you believe you have identified a security related issue or vulnerability,
then we encourage you to responsibly disclose it to us as soon as possible.

## Reporting Security Issues and Vulnerabilities

Please send an email to <MLG-Security@arm.com> with the subject
`Ethos-U Security`. In the body of the email include as much information as
possible about the issue or vulnerability and any additional contact details.