General Information

• This documentation describes a version of the Crypto Library Normal Secure (CLNS). To identify your version of the CLNS, see #nxpCl_GetVersion.
• The CLNS is separated into software components, each of which encapsulates a disjoint subset of its functionality with a common purpose. For example, that purpose can be the abstraction of a hardware IP (Intellectual Property) or the implementation of a specific cryptographic algorithm.
  • Each component has a name that begins with the prefix nxpCl.
  • The names of all header files, functions and data types belonging to a component named <component-name> begin with the prefix <component-name>_.
  • The names of all preprocessor macros belonging to a component named nxpCl<Name> begin with the prefix NXPCL<NAME>_.
• Additionally, there is some component-independent functionality, such as CLNS version information.
  • The names of all header files, functions and data types that are part of component-independent functionality begin with the prefix nxpCl_.
  • The names of all preprocessor macros that are part of component-independent functionality begin with the prefix NXPCL_.
• The CLNS API consists only of the declarations contained in the API header files. Other functions, macros or types found in other source files should not be used.
• In order to minimize CPU wait cycles during coprocessor activities, some CLNS functions (non-blocking functions) are implemented in a non-blocking way, which means that the underlying operation has not completed at function return.
  It is the caller's responsibility to ensure that the operation has completed before further processing on the operation output data is performed.
  The names of all non-blocking functions end with the suffix _Async.

Release Content

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:

• The 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.
• The examples folder contains integration example code for each included component.
• The includes folder directly contains the header source files that make up the API of the CLNS.
• The includes/platform folder contains platform-specific header files that are required for integration of the CLNS.
• The static_library folder contains a static library (archive of object code files) that contains the CLNS binaries.
• The LICENSE.htm file contains the NXP Software License Agreement.
• The softwareContentRegister.txt file contains the NXP Software Content Register. Note that this file is identical to the softwareContentRegister.txt delivered alongside the archive.