diff options
author | Tom Rini <trini@konsulko.com> | 2023-01-27 22:48:14 +0300 |
---|---|---|
committer | Tom Rini <trini@konsulko.com> | 2023-01-27 22:48:14 +0300 |
commit | aa7c61f62923a1c9e9ec7f588ad37016d8c7323c (patch) | |
tree | 1342a4a1602a41c8b9b58d21516ba1bb638cbe50 /doc/develop | |
parent | 424d4f4509a97887647fae9a2a390f043cd60772 (diff) | |
parent | 15436faa46a9958b019aea22d24bc52eb1da15ff (diff) | |
download | u-boot-aa7c61f62923a1c9e9ec7f588ad37016d8c7323c.tar.xz |
Merge tag 'efi-2023-04-rc1-3' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request efi-2023-04-rc1-3
Documentation:
* Improve the sl-mx8mm documenation
* Clean up README, move some section to HTML
* Man-pages for the mtime and sleep command
* Description of reducible builds
* Document dynamic event handlers
UEFI:
* Support scrolling in eficonfig command
Other:
* fix mtest on 64 bit systems
Diffstat (limited to 'doc/develop')
-rw-r--r-- | doc/develop/directories.rst | 76 | ||||
-rw-r--r-- | doc/develop/event.rst | 23 | ||||
-rw-r--r-- | doc/develop/index.rst | 1 |
3 files changed, 100 insertions, 0 deletions
diff --git a/doc/develop/directories.rst b/doc/develop/directories.rst new file mode 100644 index 0000000000..112b5655f6 --- /dev/null +++ b/doc/develop/directories.rst @@ -0,0 +1,76 @@ +Directory hierarchy +=================== + +.. list-table:: + :header-rows: 1 + + * - Directory path + - Usage + * - /arch + - Architecture-specific files + * - /arch/arc + - Files relating to ARC architecture + * - /arch/arm + - Files relating to ARM architecture + * - /arch/m68k + - Files relating to m68k architecture + * - /arch/microblaze + - Files relating to microblaze architecture + * - /arch/mips + - Files relating to MIPS architecture + * - /arch/nios2 + - Files relating to Altera NIOS2 architecture + * - /arch/powerpc + - Files relating to PowerPC architecture + * - /arch/riscv + - Files relating to RISC-V architecture + * - /arch/sandbox + - Files relating to HW-independent "sandbox" + * - /arch/sh + - Files relating to SH architecture + * - /arch/x86 + - Files relating to x86 architecture + * - /arch/xtensa + - Files relating to Xtensa architecture + * - /api + - Machine/arch-independent API for external apps + * - /board + - Board-dependent files + * - /boot + - Support for images and booting + * - /cmd + - U-Boot commands functions + * - /common + - Misc architecture-independent functions + * - /configs + - Board default configuration files + * - /disk + - Code for disk drive partition handling + * - /doc + - Documentation (a mix of ReST and READMEs) + * - /drivers + - Device drivers + * - /dts + - Makefile for building internal U-Boot fdt. + * - /env + - Environment support + * - /examples + - Example code for standalone applications, etc. + * - /fs + - Filesystem code (cramfs, ext2, jffs2, etc.) + * - /include + - Header Files + * - /lib + - Library routines relating to all architectures + * - /Licenses + - Various license files + * - /net + - Networking code + * - /post + - Power On Self Test + * - /scripts + - Various build scripts and Makefiles + * - /test + - Various unit test files + * - /tools + - Tools to build and sign FIT images, etc. diff --git a/doc/develop/event.rst b/doc/develop/event.rst index 6951ec97e7..4ff5934837 100644 --- a/doc/develop/event.rst +++ b/doc/develop/event.rst @@ -64,3 +64,26 @@ in an image, use $(CROSS_COMPILE)nm:: nm u-boot |grep evspy |grep list 00000000002d6300 D _u_boot_list_2_evspy_info_2_EVT_MISC_INIT_F + +Logging is also available. Events use category `LOGC_EVENT`, so you can enable +logging on that, or add `#define LOG_DEBUG` to the top of `common/event.c` to +see events being sent. + + +Dynamic events +-------------- + +Static events provide a way of dealing with events known at build time. In some +cases we want to attach an event handler at runtime. For example, we may wish +to be notified when a particular device is probed or removed. + +This can be handled by enabling `CONFIG_EVENT_DYNAMIC`. It is then possible to +call `event_register()` to register a new handler for a particular event. + +Dynamic event handlers are called after all the static event spy handlers have +been processed. Of course, since dynamic event handlers are created at runtime +it is not possible to use the `event_dump.py` to see them. + +At present there is no way to list dynamic event handlers from the command line, +nor to deregister a dynamic event handler. These features can be added when +needed. diff --git a/doc/develop/index.rst b/doc/develop/index.rst index 79d7736b13..a52ad630d0 100644 --- a/doc/develop/index.rst +++ b/doc/develop/index.rst @@ -24,6 +24,7 @@ Implementation .. toctree:: :maxdepth: 1 + directories bloblist bootstd ci_testing |