diff --git a/doc/contribute/bin_blobs.rst b/doc/contribute/bin_blobs.rst index 14c181e4058..21cd3d2fc93 100644 --- a/doc/contribute/bin_blobs.rst +++ b/doc/contribute/bin_blobs.rst @@ -5,7 +5,7 @@ Binary Blobs In the context of an operating system that supports multiple architectures and many different IC families, some functionality may be unavailable without the -help of executable code distributed in binary form. Binary blobs (or blobs for +help of executable code distributed in binary form. Binary blobs (or blobs for short) are files containing proprietary machine code or data in a binary format, e.g. without corresponding source code released under an OSI approved license. @@ -47,7 +47,7 @@ Blobs are fetched from official third-party sources by the :ref:`west blobs The blobs themselves must be specified in the :ref:`module.yml ` files included in separate Zephyr :ref:`module repositories -` maintained by their respective vendors. This means that in order to +` maintained by their respective vendors. This means that in order to include a reference to a binary blob to the upstream Zephyr distribution, a module repository must exist first or be created as part of the submission process. @@ -104,7 +104,7 @@ The following binary blob types are acceptable in Zephyr: precompiled binary form, typically for SoC peripherals. An example could be an enablement library for a wireless peripheral * Firmware images: An image containing the executable code for a secondary - processor or CPU. This can be full or partial (typically delta or patch data) + processor or CPU. This can be full or partial (typically delta or patch data) and is generally copied into RAM or flash memory by the main CPU. An example could be the firmware for the core running a Bluetooth LE Controller * Miscellaneous binary data files. An example could be pre-trained neural @@ -158,7 +158,7 @@ Toolchain requirements ====================== Precompiled library blobs must be in a data format which is compatible with and -can be linked by a toolchain supported by the Zephyr Project. This is required +can be linked by a toolchain supported by the Zephyr Project. This is required for maintainability and usability. Use of such libraries may require special compiler and/or linker flags, however. For example, a porting layer may require special flags, or a static archive may require use of specific linker flags.