diff options
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/index.rst | 2 | ||||
-rw-r--r-- | doc/api/setjmp.rst | 20 | ||||
-rw-r--r-- | doc/api/uthread.rst | 19 |
3 files changed, 41 insertions, 0 deletions
diff --git a/doc/api/index.rst b/doc/api/index.rst index a108718ea99..506843ed74a 100644 --- a/doc/api/index.rst +++ b/doc/api/index.rst @@ -25,6 +25,8 @@ U-Boot API documentation rng sandbox serial + setjmp sysreset timer unicode + uthread diff --git a/doc/api/setjmp.rst b/doc/api/setjmp.rst new file mode 100644 index 00000000000..c30e51c2b55 --- /dev/null +++ b/doc/api/setjmp.rst @@ -0,0 +1,20 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Long jump API +============= + +.. kernel-doc:: include/setjmp.h + :doc: Overview + +.. kernel-doc:: include/setjmp.h + :internal: + +Example +------- + +Here is an example showing how to use the a long jump functions and +initjmp() in particular: + +.. literalinclude:: ../../test/lib/initjmp.c + :language: c + :linenos: diff --git a/doc/api/uthread.rst b/doc/api/uthread.rst new file mode 100644 index 00000000000..8b25cc1ff80 --- /dev/null +++ b/doc/api/uthread.rst @@ -0,0 +1,19 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +Uthread API +=========== + +.. kernel-doc:: include/uthread.h + :doc: Overview + +.. kernel-doc:: include/uthread.h + :internal: + +Example +------- + +Here is an example of how to use this API: + +.. literalinclude:: ../../test/lib/uthread.c + :language: c + :linenos: |