nrf_cc310: Added description for cc310 drivers

Added description for:
- cc310 entropy driver
- cc310 hw initialization

Signed-off-by: Torsten Rasmussen <[email protected]>

Author: tejlmand

doc/CMakeLists.txt

@@ -151,6 +151,7 @@ set(NRF_EXTRACT_CONTENT_COMMAND
   "*.rst:boards:${NRF_RST_OUT}"
   "*.rst:include:${NRF_RST_OUT}"
   "*.rst:lib:${NRF_RST_OUT}"
+  "*.rst:drivers:${NRF_RST_OUT}"
   "*.rst:scripts:${NRF_RST_OUT}"
   "*.rst:applications:${NRF_RST_OUT}/doc/nrf"
   "*.rst:samples:${NRF_RST_OUT}/doc/nrf"
@@ -159,6 +160,7 @@ set(NRF_EXTRACT_CONTENT_COMMAND
   "changelog.rst:doc:${NRF_RST_OUT}/doc/nrf"
   "*.rst:include:${NRF_RST_OUT}/doc/nrf"
   "*.rst:lib:${NRF_RST_OUT}/doc/nrf"
+  "*.rst:drivers:${NRF_RST_OUT}/doc/nrf"
   "*.rst:scripts:${NRF_RST_OUT}/doc/nrf"
 )
 

doc/nrf/drivers.rst

@@ -13,3 +13,6 @@ Here you can find documentation for these drivers, including API documentation.
    :glob:
 
    ../../include/drivers/*
+   ../../drivers/entropy/*
+   ../../drivers/hw_cc310/*
+   ../../drivers/net/*

drivers/entropy/entropy_cc310.rst

@@ -0,0 +1,28 @@
+.. _lib_entropy_cc310:
+
+Entropy CC310 Driver
+####################
+
+The Entropy CC310 Driver can be used to to generate random data using the Arm
+CryptoCell CC310 hardware.
+
+
+When used in nRF52840 the Entropy CC310 Driver will gather entropy by using the
+CC310 hardware through the :ref:`nrf_cc310_platform_readme`.
+
+
+When used in the nRF9160 in a secure application, :ref:`ug_nrf9160`, or when the
+Secure Partition Manager is not used, the Entropy CC310 Driver will gather
+entropy by using the CC310 hardware through the :ref:`nrf_cc310_platform_readme`.
+
+
+When used in the nRF9160 in a non-secure application, :ref:`ug_nrf9160`
+the driver will gather entropy through the :ref:`lib_secure_services` library.
+
+API documentation
+*****************
+
+| Header file: :file:`<NCS>/zephyr/include/drivers/entropy.h`
+| Source file: :file:`drivers/entropy_cc310/entropy_cc310.c`
+
+The Entropy CC310 Driver implements the Zephyr :ref:`zephyr:entropy_interface` API.

drivers/hw_cc310/hw_cc310.rst

@@ -0,0 +1,23 @@
+.. _lib_hw_cc310:
+
+Hardware CC310 Driver
+#####################
+
+The Hardware CC310 Driver ensures correct initialization of the :ref:`nrf_cc310_platform_readme`.
+
+The Hardware CC310 Driver ensures the following functionality is correctly initialized:
+
+* CC310 abort functions
+* mutex initialization
+* platform initialization with/without RNG
+
+The following :option:`CONFIG_HW_CC310` Kconfig variable controls initialization of the Hardware
+CC310 Driver.
+
+API documentation
+*****************
+
+| Source file: :file:`drivers/hw_cc310/hw_cc310.c`
+
+See the :ref:`crypto_api_nrf_cc310_platform` APIs for functions available after
+`Hardware CC310 Driver`_ initialization.