Image Module API
================

Module implementing functionality of srktool, dcdgen, mkimage and other similar tools.


Image Classes
-------------
.. automodule:: spsdk.image.images
   :exclude-members: EnumAppType
   :members:
   :undoc-members:
   :show-inheritance:


Image Commands
--------------
.. automodule:: spsdk.image.commands
   :members:
   :undoc-members:
   :show-inheritance:


Image Headers
-------------

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


Secret Module
-------------
.. automodule:: spsdk.image.secret
   :members:
   :undoc-members:
   :show-inheritance:


Data Segments
-------------
.. automodule:: spsdk.image.segments
   :members:
   :undoc-members:
   :show-inheritance:

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:

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_container
   :members:
   :undoc-members:
   :show-inheritance:

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