]>
Commit | Line | Data |
---|---|---|
ec8f24b7 | 1 | # SPDX-License-Identifier: GPL-2.0-only |
267c4025 MD |
2 | menuconfig SAMPLES |
3 | bool "Sample kernel code" | |
4 | help | |
5 | You can build and test sample kernel code here. | |
6 | ||
7 | if SAMPLES | |
8 | ||
87ffbba9 MY |
9 | config SAMPLE_AUXDISPLAY |
10 | bool "auxdisplay sample" | |
11 | depends on CC_CAN_LINK | |
12 | ||
9cfe06f8 | 13 | config SAMPLE_TRACE_EVENTS |
96d17980 LZ |
14 | tristate "Build trace_events examples -- loadable modules only" |
15 | depends on EVENT_TRACING && m | |
9cfe06f8 | 16 | help |
953c2f05 SRG |
17 | This builds the trace event example module. |
18 | ||
19 | config SAMPLE_TRACE_CUSTOM_EVENTS | |
20 | tristate "Build custom trace event example -- loadable modules only" | |
21 | depends on EVENT_TRACING && m | |
22 | help | |
23 | This builds the custom trace event example module. | |
9cfe06f8 | 24 | |
aad108aa SRRH |
25 | config SAMPLE_TRACE_PRINTK |
26 | tristate "Build trace_printk module - tests various trace_printk formats" | |
27 | depends on EVENT_TRACING && m | |
28 | help | |
29 | This builds a module that calls trace_printk() and can be used to | |
30 | test various trace_printk() calls from a module. | |
31 | ||
b06457c8 SRV |
32 | config SAMPLE_FTRACE_DIRECT |
33 | tristate "Build register_ftrace_direct() example" | |
34 | depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m | |
c316eb44 | 35 | depends on HAVE_SAMPLE_FTRACE_DIRECT |
b06457c8 SRV |
36 | help |
37 | This builds an ftrace direct function example | |
38 | that hooks to wake_up_process and prints the parameters. | |
39 | ||
503e4510 HC |
40 | config SAMPLE_FTRACE_DIRECT_MULTI |
41 | tristate "Build register_ftrace_direct_multi() example" | |
42 | depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m | |
43 | depends on HAVE_SAMPLE_FTRACE_DIRECT_MULTI | |
44 | help | |
45 | This builds an ftrace direct function example | |
46 | that hooks to wake_up_process and schedule, and prints | |
47 | the function addresses. | |
48 | ||
89ed4249 DI |
49 | config SAMPLE_TRACE_ARRAY |
50 | tristate "Build sample module for kernel access to Ftrace instancess" | |
51 | depends on EVENT_TRACING && m | |
52 | help | |
53 | This builds a module that demonstrates the use of various APIs to | |
54 | access Ftrace instances from within the kernel. | |
55 | ||
40efcb05 | 56 | config SAMPLE_KOBJECT |
e7e34917 | 57 | tristate "Build kobject examples" |
40efcb05 GKH |
58 | help |
59 | This config option will allow you to build a number of | |
60 | different kobject sample modules showing how to use kobjects, | |
61 | ksets, and ktypes properly. | |
62 | ||
63 | If in doubt, say "N" here. | |
64 | ||
804defea AM |
65 | config SAMPLE_KPROBES |
66 | tristate "Build kprobes examples -- loadable modules only" | |
67 | depends on KPROBES && m | |
68 | help | |
69 | This build several kprobes example modules. | |
70 | ||
71 | config SAMPLE_KRETPROBES | |
72 | tristate "Build kretprobes example -- loadable modules only" | |
73 | default m | |
74 | depends on SAMPLE_KPROBES && KRETPROBES | |
75 | ||
43203993 P |
76 | config SAMPLE_HW_BREAKPOINT |
77 | tristate "Build kernel hardware breakpoint examples -- loadable module only" | |
78 | depends on HAVE_HW_BREAKPOINT && m | |
79 | help | |
80 | This builds kernel hardware breakpoint example modules. | |
81 | ||
6ee64cc3 MH |
82 | config SAMPLE_FPROBE |
83 | tristate "Build fprobe examples -- loadable modules only" | |
84 | depends on FPROBE && m | |
85 | help | |
86 | This builds a fprobe example module. This module has an option 'symbol'. | |
87 | You can specify a probed symbol or symbols separated with ','. | |
88 | ||
5bf2b193 SS |
89 | config SAMPLE_KFIFO |
90 | tristate "Build kfifo examples -- loadable modules only" | |
91 | depends on m | |
92 | help | |
93 | This config option will allow you to build a number of | |
94 | different kfifo sample modules showing how to use the | |
95 | generic kfifo API. | |
96 | ||
97 | If in doubt, say "N" here. | |
98 | ||
4aad8f51 | 99 | config SAMPLE_KDB |
25985edc | 100 | tristate "Build kdb command example -- loadable modules only" |
4aad8f51 JW |
101 | depends on KGDB_KDB && m |
102 | help | |
103 | Build an example of how to dynamically add the hello | |
104 | command to the kdb shell. | |
105 | ||
842891be BA |
106 | config SAMPLE_QMI_CLIENT |
107 | tristate "Build qmi client sample -- loadable modules only" | |
108 | depends on m | |
109 | depends on ARCH_QCOM | |
dea4bd19 | 110 | depends on NET |
842891be BA |
111 | select QCOM_QMI_HELPERS |
112 | help | |
113 | Build an QMI client sample driver, which demonstrates how to | |
114 | communicate with a remote QRTR service, using QMI encoded messages. | |
115 | ||
779b96d2 OBC |
116 | config SAMPLE_RPMSG_CLIENT |
117 | tristate "Build rpmsg client sample -- loadable modules only" | |
118 | depends on RPMSG && m | |
119 | help | |
120 | Build an rpmsg client sample driver, which demonstrates how | |
121 | to communicate with an AMP-configured remote processor over | |
122 | the rpmsg bus. | |
123 | ||
12cf89b5 | 124 | config SAMPLE_LIVEPATCH |
439e7271 | 125 | tristate "Build live patching samples -- loadable modules only" |
12cf89b5 | 126 | depends on LIVEPATCH && m |
13d1cf7e | 127 | help |
439e7271 | 128 | Build sample live patch demonstrations. |
13d1cf7e | 129 | |
51798222 CH |
130 | config SAMPLE_CONFIGFS |
131 | tristate "Build configfs patching sample -- loadable modules only" | |
132 | depends on CONFIGFS_FS && m | |
133 | help | |
134 | Builds a sample configfs interface. | |
135 | ||
14fbff6b AB |
136 | config SAMPLE_CONNECTOR |
137 | tristate "Build connector sample -- loadable modules only" | |
e949f4c2 | 138 | depends on CONNECTOR && HEADERS_INSTALL && m |
14fbff6b AB |
139 | help |
140 | When enabled, this builds both a sample kernel module for | |
141 | the connector interface and a user space tool to communicate | |
142 | with it. | |
baa293e9 | 143 | See also Documentation/driver-api/connector.rst |
14fbff6b | 144 | |
54510930 GKB |
145 | config SAMPLE_FANOTIFY_ERROR |
146 | bool "Build fanotify error monitoring sample" | |
8fc70b3a | 147 | depends on FANOTIFY && CC_CAN_LINK && HEADERS_INSTALL |
54510930 GKB |
148 | help |
149 | When enabled, this builds an example code that uses the | |
150 | FAN_FS_ERROR fanotify mechanism to monitor filesystem | |
151 | errors. | |
152 | See also Documentation/admin-guide/filesystem-monitoring.rst. | |
153 | ||
e949f4c2 MY |
154 | config SAMPLE_HIDRAW |
155 | bool "hidraw sample" | |
82d00a93 | 156 | depends on CC_CAN_LINK && HEADERS_INSTALL |
e949f4c2 | 157 | |
ba84b0bf MS |
158 | config SAMPLE_LANDLOCK |
159 | bool "Landlock example" | |
160 | depends on CC_CAN_LINK && HEADERS_INSTALL | |
161 | help | |
162 | Build a simple Landlock sandbox manager able to start a process | |
163 | restricted by a user-defined filesystem access control policy. | |
164 | ||
e949f4c2 MY |
165 | config SAMPLE_PIDFD |
166 | bool "pidfd sample" | |
60fb0b12 | 167 | depends on CC_CAN_LINK && HEADERS_INSTALL |
e949f4c2 | 168 | |
f6041c1d | 169 | config SAMPLE_SECCOMP |
7206c124 | 170 | bool "Build seccomp sample code" |
f59e7668 | 171 | depends on SECCOMP_FILTER && CC_CAN_LINK && HEADERS_INSTALL |
f6041c1d OJ |
172 | help |
173 | Build samples of seccomp filters using various methods of | |
174 | BPF filter construction. | |
175 | ||
b98ccc71 MY |
176 | config SAMPLE_TIMER |
177 | bool "Timer sample" | |
178 | depends on CC_CAN_LINK && HEADERS_INSTALL | |
179 | ||
87ecdf4f MY |
180 | config SAMPLE_UHID |
181 | bool "UHID sample" | |
182 | depends on CC_CAN_LINK && HEADERS_INSTALL | |
183 | help | |
184 | Build UHID sample program. | |
185 | ||
08c1a4ef | 186 | config SAMPLE_VFIO_MDEV_MTTY |
6b182403 | 187 | tristate "Build VFIO mtty example mediated device sample code" |
de858a05 | 188 | depends on VFIO |
8bf8c5ee | 189 | select VFIO_MDEV |
08c1a4ef AW |
190 | help |
191 | Build a virtual tty sample driver for use as a VFIO | |
192 | mediated device | |
193 | ||
d61fc96f | 194 | config SAMPLE_VFIO_MDEV_MDPY |
6b182403 | 195 | tristate "Build VFIO mdpy example mediated device sample code" |
de858a05 | 196 | depends on VFIO |
8bf8c5ee | 197 | select VFIO_MDEV |
d61fc96f GH |
198 | help |
199 | Build a virtual display sample driver for use as a VFIO | |
200 | mediated device. It is a simple framebuffer and supports | |
201 | the region display interface (VFIO_GFX_PLANE_TYPE_REGION). | |
202 | ||
cacade19 | 203 | config SAMPLE_VFIO_MDEV_MDPY_FB |
6b182403 CH |
204 | tristate "Build VFIO mdpy example guest fbdev driver" |
205 | depends on FB | |
cacade19 GH |
206 | select FB_CFB_FILLRECT |
207 | select FB_CFB_COPYAREA | |
208 | select FB_CFB_IMAGEBLIT | |
209 | help | |
210 | Guest fbdev driver for the virtual display sample driver. | |
211 | ||
a5e6e650 | 212 | config SAMPLE_VFIO_MDEV_MBOCHS |
6b182403 | 213 | tristate "Build VFIO mdpy example mediated device sample code" |
de858a05 | 214 | depends on VFIO |
8bf8c5ee | 215 | select VFIO_MDEV |
c1abca96 | 216 | select DMA_SHARED_BUFFER |
a5e6e650 GH |
217 | help |
218 | Build a virtual display sample driver for use as a VFIO | |
219 | mediated device. It supports the region display interface | |
220 | (VFIO_GFX_PLANE_TYPE_DMABUF). | |
221 | Emulate enough of qemu stdvga to make bochs-drm.ko happy. | |
222 | That is basically the vram memory bar and the bochs dispi | |
223 | interface vbe registers in the mmio register bar. | |
224 | Specifically it does *not* include any legacy vga stuff. | |
225 | Device looks a lot like "qemu -device secondary-vga". | |
226 | ||
9762dc14 CB |
227 | config SAMPLE_ANDROID_BINDERFS |
228 | bool "Build Android binderfs example" | |
fca5e949 | 229 | depends on CC_CAN_LINK && HEADERS_INSTALL |
9762dc14 CB |
230 | help |
231 | Builds a sample program to illustrate the use of the Android binderfs | |
232 | filesystem. | |
233 | ||
f1b5618e DH |
234 | config SAMPLE_VFS |
235 | bool "Build example programs that use new VFS system calls" | |
28949b84 | 236 | depends on CC_CAN_LINK && HEADERS_INSTALL |
a528d35e | 237 | help |
f1b5618e DH |
238 | Build example userspace programs that use new VFS system calls such |
239 | as mount API and statx(). Note that this is restricted to the x86 | |
240 | arch whilst it accesses system calls that aren't yet in all arches. | |
a528d35e | 241 | |
6859eba4 TW |
242 | config SAMPLE_INTEL_MEI |
243 | bool "Build example program working with intel mei driver" | |
244 | depends on INTEL_MEI | |
c4c10996 | 245 | depends on CC_CAN_LINK && HEADERS_INSTALL |
6859eba4 TW |
246 | help |
247 | Build a sample program to work with mei device. | |
248 | ||
88a8e278 MY |
249 | config SAMPLE_WATCHDOG |
250 | bool "watchdog sample" | |
251 | depends on CC_CAN_LINK | |
6859eba4 | 252 | |
f5b5a164 | 253 | config SAMPLE_WATCH_QUEUE |
8fe62e0c | 254 | bool "Build example watch_queue notification API consumer" |
214377e9 | 255 | depends on CC_CAN_LINK && HEADERS_INSTALL |
f5b5a164 DH |
256 | help |
257 | Build example userspace program to use the new mount_notify(), | |
258 | sb_notify() syscalls and the KEYCTL_WATCH_KEY keyctl() function. | |
6859eba4 | 259 | |
ede5bab8 ML |
260 | config SAMPLE_CORESIGHT_SYSCFG |
261 | tristate "Build example loadable module for CoreSight config" | |
262 | depends on CORESIGHT && m | |
263 | help | |
264 | Build an example loadable module that adds new CoreSight features | |
265 | and configuration using the CoreSight system configuration API. | |
266 | This demonstrates how a user may create their own CoreSight | |
267 | configurations and easily load them into the system at runtime. | |
268 | ||
e4fc6580 MO |
269 | source "samples/rust/Kconfig" |
270 | ||
267c4025 | 271 | endif # SAMPLES |
c316eb44 HC |
272 | |
273 | config HAVE_SAMPLE_FTRACE_DIRECT | |
274 | bool | |
0b707e57 | 275 | |
503e4510 | 276 | config HAVE_SAMPLE_FTRACE_DIRECT_MULTI |
0b707e57 | 277 | bool |