Utils Module API
=================

Module containing various functions/modules used throughout the SPSDK.

Abstract class template
--------------------------

.. automodule:: spsdk.utils.abstract
   :members:
   :undoc-members:
   :show-inheritance:


Utils easy enum
------------------

.. automodule:: spsdk.utils.spsdk_enum
   :members:
   :undoc-members:
   :show-inheritance:

Utils crypto - Certification blocks
-------------------------------------

.. automodule:: spsdk.utils.crypto.cert_blocks
   :members:
   :undoc-members:
   :show-inheritance:

Utils crypto - Inline Encryption Engine (IEE)
----------------------------------------------

.. automodule:: spsdk.utils.crypto.iee
   :members:
   :undoc-members:
   :show-inheritance:

Utils crypto - On-the-Fly AES Decryption (OTFAD)
-------------------------------------------------

.. automodule:: spsdk.utils.crypto.otfad
   :members:
   :undoc-members:
   :show-inheritance:

Utils crypto - Root Keys Hash Table (RKHT)
------------------------------------------------

.. automodule:: spsdk.utils.crypto.rkht
   :members:
   :undoc-members:
   :show-inheritance:

Utils crypto - Root Of Trust (RoT)
------------------------------------------------

.. automodule:: spsdk.utils.crypto.rot
   :members:
   :undoc-members:
   :show-inheritance:

General utils
---------------

.. automodule:: spsdk.utils.misc
   :members:
   :undoc-members:
   :show-inheritance:

Image utils
-----------

.. automodule:: spsdk.utils.images
   :members:
   :undoc-members:
   :show-inheritance:

Interfaces utils
----------------

.. automodule:: spsdk.utils.interfaces
   :members:
   :undoc-members:
   :show-inheritance:

Serial Proxy
-------------

.. automodule:: spsdk.utils.serial_proxy
   :members:
   :undoc-members:
   :show-inheritance:


USB Filter
-------------

.. automodule:: spsdk.utils.usbfilter
   :members:
   :undoc-members:
   :show-inheritance:


Registers descriptions
--------------------------------------------------

.. automodule:: spsdk.utils.registers
   :members:
   :undoc-members:
   :show-inheritance:


USB Device Scanner
---------------------
.. automodule:: spsdk.utils.nxpdevscan
   :members:
   :undoc-members:
   :show-inheritance:


Device description
--------------------
.. automodule:: spsdk.utils.devicedescription
   :members:
   :undoc-members:
   :show-inheritance:


Module for schema-based configuration validation
--------------------------------------------------
.. automodule:: spsdk.utils.schema_validator
   :members:
   :undoc-members:
   :show-inheritance:


Utils Exceptions
----------------
.. automodule:: spsdk.utils.exceptions
   :members:
   :undoc-members:
   :show-inheritance:

Database
--------
.. automodule:: spsdk.utils.database
   :members:
   :undoc-members:
   :show-inheritance: