nxpCl
.<component-name>
begin with the prefix <component-name>_
.nxpCl<Name>
begin with the prefix NXPCL<NAME>_
.nxpCl_
.NXPCL_
._Async
.The release consists of three files, the NXP Software Content Register softwareContentRegister.txt
, the NXP Software License Agreement LICENSE.htm
and an archive with the file name extension .zip
. The archive contains the following data:
doc
folder contains Doxygen HTML documentation of the CLNS interfaces and example code. Open doc/html/index.html
in a browser to view its main page.examples
folder contains integration example code for each included component.includes
folder directly contains the header source files that make up the API of the CLNS.includes/platform
folder contains platform-specific header files that are required for integration of the CLNS.static_library
folder contains a static library (archive of object code files) that contains the CLNS binaries.LICENSE.htm
file contains the NXP Software License Agreement.softwareContentRegister.txt
file contains the NXP Software Content Register. Note that this file is identical to the softwareContentRegister.txt
delivered alongside the archive.nxpClEls
To optimize power utilization, the ELS hardware IP provides a clock gating mechanism to enable and disable itself. Prior to any ELS-based operations invoked via the CLNS, the ELS must be enabled. The CLNS API provides the following support functions to enable/disable the ELS hardware:
All input and output buffers of nxpClEls
functions must be placed in memory regions that are accessible to the ELS hardware IP.
It is the caller's responsibility to ensure that the operation of a non-blocking function has completed before further processing on the operation output data is performed. For nxpClEls
functions, this can be achieved by either polling the ELS hardware status flag or by acting on hardware interrupts. The CLNS implements the support functions #nxpClEls_WaitForOperation and #nxpClEls_LimitedWaitForOperation for the former method. #nxpClEls_WaitForOperation potentially waits an infinite amount of time, while #nxpClEls_LimitedWaitForOperation uses a counter to limit the amount of time spent waiting.
The ELS hardware IP contains a stand-alone Sha module which can be used in parallel with other ELS operations. ELS operations make use of a ELS-internal DMA (Direct Memory Access) module for data handling. The stand-alone Sha module is an exception of this behavior: It is the caller's responsibility to perform the data handling, which can be achieved using the CPU or the system DMA.
As for all other components, all input and output buffers of nxpClEls
functions that store external keys must be CPU word-aligned. From a functional perspective, all other input and output buffers of nxpClEls
functions have no alignment requirement, unless explicitly stated otherwise. Using CPU word-aligned buffers may improve operation performance.