Skip to content

Commit 766122f

Browse files
pillo79nashif
authored andcommitted
doc: llext: add note on the loader types
Add a note on the new loader types available in LLEXT.. Signed-off-by: Luca Burelli <[email protected]> Signed-off-by:
1 parent 3fcd903 commit 766122f

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

doc/services/llext/load.rst

+11-3
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,17 @@ Loading an extension
1111
An extension may be loaded using any implementation of a :c:struct:`llext_loader`
1212
which has a set of function pointers that provide the necessary functionality
1313
to read the ELF data. A loader also provides some minimal context (memory)
14-
needed by the :c:func:`llext_load` function. An implementation over a buffer
15-
containing an ELF in addressable memory in memory is available as
16-
:c:struct:`llext_buf_loader`.
14+
needed by the :c:func:`llext_load` function. Several loaders are already provided:
15+
16+
* An implementation over a buffer containing an ELF in addressable memory in
17+
memory is available as :c:struct:`llext_buf_loader`. To use this kind of
18+
loader, it is helpful to use one of the :c:macro:`LLEXT_TEMPORARY_BUF_LOADER`,
19+
:c:macro:`LLEXT_PERSISTENT_BUF_LOADER`, or :c:macro:`LLEXT_WRITABLE_BUF_LOADER`
20+
macros to tell LLEXT the appropriate type of memory buffer.
21+
22+
* An implementation that reads data from a file in the filesystem is available
23+
as the :c:struct:`llext_fs_loader`. The path to the file must be provided
24+
when creating the loader with the :c:macro:`LLEXT_FS_LOADER` macro.
1725

1826
The extensions are loaded with a call to the :c:func:`llext_load` function,
1927
passing in the extension name and the configured loader. Once that completes

0 commit comments

Comments
 (0)