diff options
| author | Simon Glass <[email protected]> | 2022-03-04 08:43:08 -0700 |
|---|---|---|
| committer | Tom Rini <[email protected]> | 2022-03-10 08:28:36 -0500 |
| commit | abe5d1184f276a0789365316061a14834dbc8dc4 (patch) | |
| tree | 23eeff85c6606bece47b2d99611786a3392416dc /doc/usage | |
| parent | 9de3773a5cbdfd64e59bfe3bec78c59454650c9a (diff) | |
event: Add documentation
Add documentation for events, including the event command.
Signed-off-by: Simon Glass <[email protected]>
Diffstat (limited to 'doc/usage')
| -rw-r--r-- | doc/usage/event.rst | 49 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 50 insertions, 0 deletions
diff --git a/doc/usage/event.rst b/doc/usage/event.rst new file mode 100644 index 00000000000..c0f8acd727b --- /dev/null +++ b/doc/usage/event.rst @@ -0,0 +1,49 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +event command +============= + +Synopsis +-------- + +:: + + event list + +Description +----------- + +The event command provides spy list. + +This shows the following information: + +Seq + Sequence number of the spy, numbered from 0 + +Type + Type of the spy, both as a number and a label. If `CONFIG_EVENT_DEBUG` is + not enabled, the label just shows `(unknown)`. + +Function + Address of the function to call + +ID + ID string for this event, if `CONFIG_EVENT_DEBUG` is enabled. Otherwise this + just shows `?`. + + +See :doc:`../develop/event` for more information on events. + +Example +------- + +:: + + => event list + Seq Type Function ID + 0 7 misc_init_f 55a070517c68 ? + +Configuration +------------- + +The event command is only available if CONFIG_CMD_EVENT=y. diff --git a/doc/usage/index.rst b/doc/usage/index.rst index 0aacf531b22..750102830b5 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -29,6 +29,7 @@ Shell commands x86/cbsysinfo conitrace echo + event exception extension exit |