Skip to content

Commit e7d1f09

Browse files
tejlmandrlubos
authored andcommitted
nrf_cc310: Added description for cc310 drivers
Added description for: - cc310 entropy driver - cc310 hw initialization Signed-off-by: Torsten Rasmussen <[email protected]>
1 parent 669649b commit e7d1f09

File tree

4 files changed

+46
-0
lines changed

4 files changed

+46
-0
lines changed

doc/CMakeLists.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,7 @@ set(NRF_EXTRACT_CONTENT_COMMAND
157157
"*.rst:boards:${NRF_RST_OUT}/doc/nrf"
158158
"release-notes*.rst:doc:${NRF_RST_OUT}/doc/nrf"
159159
"changelog.rst:doc:${NRF_RST_OUT}/doc/nrf"
160+
"*.rst:doc/nrf/drivers:${NRF_RST_OUT}"
160161
"*.rst:include:${NRF_RST_OUT}/doc/nrf"
161162
"*.rst:lib:${NRF_RST_OUT}/doc/nrf"
162163
"*.rst:scripts:${NRF_RST_OUT}/doc/nrf"

doc/nrf/drivers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,3 +13,4 @@ Here you can find documentation for these drivers, including API documentation.
1313
:glob:
1414

1515
../../include/drivers/*
16+
drivers/*

doc/nrf/drivers/entropy_cc310.rst

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
.. _lib_entropy_cc310:
2+
3+
CC310 entropy driver
4+
####################
5+
6+
You can use the CC310 entropy driver (entropy_cc310) to generate random data using the Arm CryptoCell CC310 hardware.
7+
This hardware is available on the nRF52840 and nRF9160 devices.
8+
9+
When used on nRF52840, the entropy_cc310 driver gathers entropy by using the CC310 hardware through the :ref:`nrf_cc310_platform_readme`.
10+
11+
When used on nRF9160, the driver behavior depends on whether it is used in a secure or non-secure application:
12+
13+
* When used :ref:`in a secure application <ug_nrf9160>`, or when the :ref:`lib_spm` is not used, the entropy_cc310 driver gathers entropy by using the CC310 hardware through the :ref:`nrf_cc310_platform_readme`.
14+
15+
* When used :ref:`in a non-secure application <ug_nrf9160>`, the driver gathers entropy through the :ref:`lib_secure_services` library.
16+
17+
API documentation
18+
*****************
19+
20+
| Header file: :file:`<NCS>/zephyr/include/drivers/entropy.h`
21+
| Source file: :file:`drivers/entropy_cc310/entropy_cc310.c`
22+
23+
The entropy_cc310 driver implements the Zephyr :ref:`zephyr:entropy_interface` API.

doc/nrf/drivers/hw_cc310.rst

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.. _lib_hw_cc310:
2+
3+
CC310 hardware driver
4+
#####################
5+
6+
The CC310 hardware driver (hw_cc310) ensures correct initialization of the :ref:`nrf_cc310_platform_readme`.
7+
8+
It initializes the following elements of the library:
9+
10+
* CC310 abort functions,
11+
* hardware mutex and mutex API,
12+
* platform with or without RNG.
13+
14+
You can initialize the hw_cc310 driver using the :option:`CONFIG_HW_CC310` Kconfig option.
15+
16+
API documentation
17+
*****************
18+
19+
| Source file: :file:`drivers/hw_cc310/hw_cc310.c`
20+
21+
After the hw_cc310 driver has been initialized, you can use the APIs from the :ref:`crypto_api_nrf_cc310_platform` and the :ref:`nrf_cc310_mbedcrypto_readme`.

0 commit comments

Comments
 (0)