event: Add documentation
[platform/kernel/u-boot.git] / doc / usage / event.rst
1 .. SPDX-License-Identifier: GPL-2.0+
2
3 event command
4 =============
5
6 Synopsis
7 --------
8
9 ::
10
11     event list
12
13 Description
14 -----------
15
16 The event command provides spy list.
17
18 This shows the following information:
19
20 Seq
21     Sequence number of the spy, numbered from 0
22
23 Type
24     Type of the spy, both as a number and a label. If `CONFIG_EVENT_DEBUG` is
25     not enabled, the label just shows `(unknown)`.
26
27 Function
28     Address of the function to call
29
30 ID
31     ID string for this event, if `CONFIG_EVENT_DEBUG` is enabled. Otherwise this
32     just shows `?`.
33
34
35 See :doc:`../develop/event` for more information on events.
36
37 Example
38 -------
39
40 ::
41
42     => event list
43     Seq  Type                              Function  ID
44       0  7   misc_init_f               55a070517c68  ?
45
46 Configuration
47 -------------
48
49 The event command is only available if CONFIG_CMD_EVENT=y.