Skip to content

Commit acb5318

Browse files
hug-devhug-dev
committed
CM3DS: enable TRNG with open-source TZ-TRNG driver
This patchs adds TRNG support using the upstreamed, open-source, TZ-TRNG driver. It also implements the HAL for TRNG and add it in features. The mbed-os.py script deletes files that are unused by mbed-os. Change-Id: Idf8eefd809f00d40e0ad3cf7657f2a8c2eca3505 Signed-off-by: Hugues de Valon <[email protected]>
1 parent d24c7c4 commit acb5318

File tree

20 files changed

+2126
-1
lines changed

20 files changed

+2126
-1
lines changed

‎targets/TARGET_ARM_SSG/TARGET_CM3DS_MPS2/device/drivers/TZ-TRNG/LICENSE

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "{}"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright {yyyy} {name of copyright owner}
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎targets/TARGET_ARM_SSG/TARGET_CM3DS_MPS2/device/drivers/TZ-TRNG/README.md

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
# ARM TrustZone True Number Generator
2+
3+
This software product contains the following open source components:
4+
5+
* ARM TrustZone TRNG driver.
6+
* ARM TrustZone TRNG integration test.
7+
* Characterization reference code.
8+
9+
10+
Containing:
11+
12+
* READM.md (this file)
13+
* Software and test build system:
14+
build.props
15+
proj.ext.cfg
16+
TRNG_test.c
17+
shared/
18+
host/
19+
* Software Integrator's Manual (trustzone_true_random_number_generator_software_integrators_manual_101049_0000_00_en.pdf)
20+
21+
ARM TrustZone TRNG supports 32-bit systems.
22+
The `.mbedignore` file allows the driver to be used as it is for TRNG implementation in mbed OS. That file will make it work under 800-90B TRNG mode.
23+
24+
## License
25+
26+
This software is provided under the Apache-2.0 license. Contributions to this project are accepted under the same license.
27+
28+
29+
## Release details
30+
31+
This release contains the ARM TrustZone TRNG software.
32+
33+
### Prerequisites:
34+
35+
* To be run on an Ubuntu 14.04 LTS system host for building.
36+
37+
* gcc version 4.7.3 or arm-ds5 compiler are in your PATH.
38+
39+
* If using Linux as a host on the H/W, configure the KERNEL_DIR environment variable to point to your Linux (s).
40+
41+
* The target is running Linux kernel 4.4 or FreeRTOS.
42+
43+
Download the software bundle from https://github.com/ARM-software/TZ-TRNG.
44+
45+
### Build procedure
46+
47+
**Step 1**: Open a terminal on the Ubuntu system, and use 'cd <path>' to go to the folder where you unpacked the software bundle from the ARM github url.
48+
49+
**Step 2**: Define environment variables, depending on what the hw system target is running:
50+
51+
* For a target hw system running FreeRTOS:
52+
```bash
53+
export KERNEL_DIR=/path/to/freertos
54+
```
55+
or
56+
57+
* For a target hw system running linux:
58+
```bash
59+
export KERNEL_DIR=/path/to/linux
60+
```
61+
62+
**Step 3**: Build all the binaries (common for FreeRTOS and Linux):
63+
```bash
64+
cd /path/to/tztrng
65+
make -C host/src/tztrng_lib/ clean
66+
make -C host/src/tztrng_lib/
67+
make -C host/src/tests/tztrng_test/ clean
68+
make -C host/src/tests/tztrng_test/
69+
```
70+
The tztrng library is located in:
71+
```bash
72+
host/lib/libcc_tztrng.a
73+
```
74+
75+
The integration test executable is located in the following path:
76+
- When compiling with gcc: host/bin/tztrng_test.
77+
- When compiling with armcc: host/lib/libtztrng_test.a.
78+
79+
80+
**Step 4**: Deploy:
81+
* For a target hw system running linux:
82+
83+
Copy host/bin/tztrng_test to the target linux file system and exeute:
84+
```bash
85+
./tztrng_test
86+
```
87+
88+
* For a target hw system running FreeRTOS:
89+
90+
```bash
91+
cp host/lib/libcc_tztrng.a /path/to/your/library/folder
92+
cp host/lib/libtztrng_test.a /path/to/your/library/folder
93+
cp host/src/tests/tztrng_test/tztrng_test.h /path/to/includes
94+
```
95+
96+
## Validation
97+
98+
1. Tests run
99+
100+
See "Step 4: Deploy" above.
101+
102+
1. Known issues
103+
104+
None
105+
106+
1. Planned enhancements
107+
108+
None

‎targets/TARGET_ARM_SSG/TARGET_CM3DS_MPS2/device/drivers/TZ-TRNG/host/src/tztrng_lib/include/config_fetrng.h

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
/******************************************************************************
2+
* Copyright (c) 2017-2017, ARM, All Rights Reserved *
3+
* SPDX-License-Identifier: Apache-2.0 *
4+
* *
5+
* Licensed under the Apache License, Version 2.0 (the "License"); *
6+
* you may not use this file except in compliance with the License. *
7+
* *
8+
* You may obtain a copy of the License at *
9+
* http://www.apache.org/licenses/LICENSE-2.0 *
10+
* *
11+
* Unless required by applicable law or agreed to in writing, software *
12+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT *
13+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
14+
* *
15+
* See the License for the specific language governing permissions and *
16+
* limitations under the License. *
17+
******************************************************************************/
18+
#ifndef _CC_CONFIG_FETRNG_H
19+
#define _CC_CONFIG_FETRNG_H
20+
21+
/*
22+
* This file should be updated according to the characterization process.
23+
*
24+
* sample count for each ring oscillator
25+
* - for unallowed rosc, sample count = 0
26+
*/
27+
28+
#define CC_CONFIG_SAMPLE_CNT_ROSC_1 0
29+
#define CC_CONFIG_SAMPLE_CNT_ROSC_2 150
30+
#define CC_CONFIG_SAMPLE_CNT_ROSC_3 458
31+
#define CC_CONFIG_SAMPLE_CNT_ROSC_4 750
32+
33+
#endif
34+

‎targets/TARGET_ARM_SSG/TARGET_CM3DS_MPS2/device/drivers/TZ-TRNG/host/src/tztrng_lib/include/config_trng90b.h

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
/******************************************************************************
2+
* Copyright (c) 2017-2017, ARM, All Rights Reserved *
3+
* SPDX-License-Identifier: Apache-2.0 *
4+
* *
5+
* Licensed under the Apache License, Version 2.0 (the "License"); *
6+
* you may not use this file except in compliance with the License. *
7+
* *
8+
* You may obtain a copy of the License at *
9+
* http://www.apache.org/licenses/LICENSE-2.0 *
10+
* *
11+
* Unless required by applicable law or agreed to in writing, software *
12+
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT *
13+
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
14+
* *
15+
* See the License for the specific language governing permissions and *
16+
* limitations under the License. *
17+
******************************************************************************/
18+
#ifndef _CC_CONFIG_TRNG90B_H
19+
#define _CC_CONFIG_TRNG90B_H
20+
21+
/*
22+
This file should be updated according to the characterization process.
23+
*/
24+
25+
/* sample count for each ring oscillator */
26+
/* for unallowed rosc, sample count = 0 */
27+
#define CC_CONFIG_SAMPLE_CNT_ROSC_1 200
28+
#define CC_CONFIG_SAMPLE_CNT_ROSC_2 200
29+
#define CC_CONFIG_SAMPLE_CNT_ROSC_3 300
30+
#define CC_CONFIG_SAMPLE_CNT_ROSC_4 100
31+
32+
#endif
33+

0 commit comments

Comments
 (0)