Image Module API
================
.. automodule:: spsdk.image


Image Segments
--------------
.. automodule:: spsdk.image.segments_base
   :members:
   :undoc-members:
   :show-inheritance:

TrustZone
-------------
.. automodule:: spsdk.image.trustzone
   :members: TrustZoneType
   :special-members: TrustZone
   :exclude-members: PRESET_DIR, CONFIG_FILE
   :undoc-members:
   :show-inheritance:


Support for BEE encryption for RT10xx devices
----------------------------------------------
.. automodule:: spsdk.image.bee
   :members:
   :undoc-members:
   :show-inheritance:


Support for KeyStore used in MasterBootImage
---------------------------------------------
.. automodule:: spsdk.image.keystore
   :members:
   :undoc-members:
   :show-inheritance:


Master Boot Image
-------------------------
.. automodule:: spsdk.image.mbi.mbi
   :members:
   :undoc-members:
   :show-inheritance:


Master Boot Image - miscellaneous functions
--------------------------------------------
.. automodule:: spsdk.image.misc
   :members:
   :undoc-members:
   :show-inheritance:


Master Boot Image - mixin classes
----------------------------------
.. automodule:: spsdk.image.mbi.mbi_mixin
   :members:
   :undoc-members:
   :show-inheritance:


Image Exceptions
-----------------
.. automodule:: spsdk.image.exceptions
   :members:
   :undoc-members:
   :show-inheritance:

AHAB Container
------------------
.. automodule:: spsdk.image.ahab.ahab_container
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource

AHAB Utilities
------------------
.. automodule:: spsdk.image.ahab.utils
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource

AHAB Container Interface
------------------------
.. automodule:: spsdk.image.ahab.ahab_abstract_interfaces
   :members:
   :undoc-members:
   :show-inheritance:
   :member-order: bysource

Signed Messages
------------------
.. automodule:: spsdk.image.ahab.signed_msg
   :members:
   :undoc-members:
   :show-inheritance:

Type-Length-Value blobs
------------------------

.. automodule:: spsdk.image.ahab.tlv
   :members:
   :undoc-members:
   :show-inheritance:

Bootable image
----------------
.. automodule:: spsdk.image.bootable_image.bimg
   :members:
   :undoc-members:
   :show-inheritance:

Bootable image segments
-----------------------
.. automodule:: spsdk.image.bootable_image.segments
   :members:
   :undoc-members:
   :show-inheritance:

FCB - Flash Configuration Block
---------------------------------
.. automodule:: spsdk.image.fcb.fcb
   :members:
   :undoc-members:
   :show-inheritance:

HAB - High Assurance Boot
----------------------------
.. automodule:: spsdk.image.hab
   :members:
   :undoc-members:
   :show-inheritance:

HAB Container
----------------------------
.. automodule:: spsdk.image.hab.hab_image
   :members:
   :undoc-members:
   :show-inheritance:

XMCD
----------------------------
.. automodule:: spsdk.image.xmcd.xmcd
   :members:
   :undoc-members:
   :show-inheritance:

Inline Encryption Engine (IEE)
----------------------------------------------

.. automodule:: spsdk.image.iee
   :members:
   :undoc-members:
   :show-inheritance:

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

.. automodule:: spsdk.image.otfad
   :members:
   :undoc-members:
   :show-inheritance:

Certification blocks
-------------------------------------

.. automodule:: spsdk.image.cert_block.cert_blocks
   :members:
   :undoc-members:
   :show-inheritance:

Certification blocks - Root Keys Hash Table (RKHT)
--------------------------------------------------

.. automodule:: spsdk.image.cert_block.rkht
   :members:
   :undoc-members:
   :show-inheritance:

Certification blocks - Root Of Trust (RoT)
------------------------------------------------

.. automodule:: spsdk.image.cert_block.rot
   :members:
   :undoc-members:
   :show-inheritance:

HSE Key Catalog
------------------------------------------------

.. automodule:: spsdk.image.hse.key_catalog
   :members:
   :undoc-members:
   :show-inheritance:

HSE Key Info
------------------------------------------------

.. automodule:: spsdk.image.hse.key_info
   :members:
   :undoc-members:
   :show-inheritance:

HSE Secure Memory Region
------------------------------------------------

.. automodule:: spsdk.image.hse.smr
   :members:
   :undoc-members:
   :show-inheritance: