1 # SPDX-License-Identifier: GPL-2.0-only 1 # SPDX-License-Identifier: GPL-2.0-only
2 menuconfig SAMPLES 2 menuconfig SAMPLES
3 bool "Sample kernel code" 3 bool "Sample kernel code"
4 help 4 help
5 You can build and test sample kernel 5 You can build and test sample kernel code here.
6 6
7 if SAMPLES 7 if SAMPLES
8 8
9 config SAMPLE_AUXDISPLAY 9 config SAMPLE_AUXDISPLAY
10 bool "auxdisplay sample" 10 bool "auxdisplay sample"
11 depends on CC_CAN_LINK 11 depends on CC_CAN_LINK
12 12
13 config SAMPLE_TRACE_EVENTS 13 config SAMPLE_TRACE_EVENTS
14 tristate "Build trace_events examples 14 tristate "Build trace_events examples -- loadable modules only"
15 depends on EVENT_TRACING && m 15 depends on EVENT_TRACING && m
16 help 16 help
17 This builds the trace event example 17 This builds the trace event example module.
18 18
19 config SAMPLE_TRACE_CUSTOM_EVENTS 19 config SAMPLE_TRACE_CUSTOM_EVENTS
20 tristate "Build custom trace event exa 20 tristate "Build custom trace event example -- loadable modules only"
21 depends on EVENT_TRACING && m 21 depends on EVENT_TRACING && m
22 help 22 help
23 This builds the custom trace event e 23 This builds the custom trace event example module.
24 24
25 config SAMPLE_TRACE_PRINTK 25 config SAMPLE_TRACE_PRINTK
26 tristate "Build trace_printk module - 26 tristate "Build trace_printk module - tests various trace_printk formats"
27 depends on EVENT_TRACING && m 27 depends on EVENT_TRACING && m
28 help 28 help
29 This builds a module that calls trace 29 This builds a module that calls trace_printk() and can be used to
30 test various trace_printk() calls fro 30 test various trace_printk() calls from a module.
31 31
32 config SAMPLE_FTRACE_DIRECT 32 config SAMPLE_FTRACE_DIRECT
33 tristate "Build register_ftrace_direct 33 tristate "Build register_ftrace_direct() example"
34 depends on DYNAMIC_FTRACE_WITH_DIRECT_ 34 depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m
35 depends on HAVE_SAMPLE_FTRACE_DIRECT 35 depends on HAVE_SAMPLE_FTRACE_DIRECT
36 help 36 help
37 This builds an ftrace direct functio 37 This builds an ftrace direct function example
38 that hooks to wake_up_process and pr 38 that hooks to wake_up_process and prints the parameters.
39 39
40 config SAMPLE_FTRACE_DIRECT_MULTI 40 config SAMPLE_FTRACE_DIRECT_MULTI
41 tristate "Build register_ftrace_direct 41 tristate "Build register_ftrace_direct() on multiple ips example"
42 depends on DYNAMIC_FTRACE_WITH_DIRECT_ 42 depends on DYNAMIC_FTRACE_WITH_DIRECT_CALLS && m
43 depends on HAVE_SAMPLE_FTRACE_DIRECT_M 43 depends on HAVE_SAMPLE_FTRACE_DIRECT_MULTI
44 help 44 help
45 This builds an ftrace direct functio 45 This builds an ftrace direct function example
46 that hooks to wake_up_process and sc 46 that hooks to wake_up_process and schedule, and prints
47 the function addresses. 47 the function addresses.
48 48
49 config SAMPLE_FTRACE_OPS 49 config SAMPLE_FTRACE_OPS
50 tristate "Build custom ftrace ops exam 50 tristate "Build custom ftrace ops example"
51 depends on FUNCTION_TRACER 51 depends on FUNCTION_TRACER
52 help 52 help
53 This builds an ftrace ops example th 53 This builds an ftrace ops example that hooks two functions and
54 measures the time taken to invoke on 54 measures the time taken to invoke one function a number of times.
55 55
56 config SAMPLE_TRACE_ARRAY 56 config SAMPLE_TRACE_ARRAY
57 tristate "Build sample module for kern 57 tristate "Build sample module for kernel access to Ftrace instancess"
58 depends on EVENT_TRACING && m 58 depends on EVENT_TRACING && m
59 help 59 help
60 This builds a module that demonstrate 60 This builds a module that demonstrates the use of various APIs to
61 access Ftrace instances from within t 61 access Ftrace instances from within the kernel.
62 62
63 config SAMPLE_KOBJECT 63 config SAMPLE_KOBJECT
64 tristate "Build kobject examples" 64 tristate "Build kobject examples"
65 help 65 help
66 This config option will allow you to 66 This config option will allow you to build a number of
67 different kobject sample modules sho 67 different kobject sample modules showing how to use kobjects,
68 ksets, and ktypes properly. 68 ksets, and ktypes properly.
69 69
70 If in doubt, say "N" here. 70 If in doubt, say "N" here.
71 71
72 config SAMPLE_KPROBES 72 config SAMPLE_KPROBES
73 tristate "Build kprobes examples -- lo 73 tristate "Build kprobes examples -- loadable modules only"
74 depends on KPROBES && m 74 depends on KPROBES && m
75 help 75 help
76 This build several kprobes example m 76 This build several kprobes example modules.
77 77
78 config SAMPLE_KRETPROBES 78 config SAMPLE_KRETPROBES
79 tristate "Build kretprobes example -- 79 tristate "Build kretprobes example -- loadable modules only"
80 default m 80 default m
81 depends on SAMPLE_KPROBES && KRETPROBE 81 depends on SAMPLE_KPROBES && KRETPROBES
82 82
83 config SAMPLE_HW_BREAKPOINT 83 config SAMPLE_HW_BREAKPOINT
84 tristate "Build kernel hardware breakp 84 tristate "Build kernel hardware breakpoint examples -- loadable module only"
85 depends on HAVE_HW_BREAKPOINT && m 85 depends on HAVE_HW_BREAKPOINT && m
86 help 86 help
87 This builds kernel hardware breakpoi 87 This builds kernel hardware breakpoint example modules.
88 88
89 config SAMPLE_FPROBE 89 config SAMPLE_FPROBE
90 tristate "Build fprobe examples -- loa 90 tristate "Build fprobe examples -- loadable modules only"
91 depends on FPROBE && m 91 depends on FPROBE && m
92 help 92 help
93 This builds a fprobe example module. 93 This builds a fprobe example module. This module has an option 'symbol'.
94 You can specify a probed symbol or s 94 You can specify a probed symbol or symbols separated with ','.
95 95
96 config SAMPLE_KFIFO 96 config SAMPLE_KFIFO
97 tristate "Build kfifo examples -- load 97 tristate "Build kfifo examples -- loadable modules only"
98 depends on m 98 depends on m
99 help 99 help
100 This config option will allow you to 100 This config option will allow you to build a number of
101 different kfifo sample modules showi 101 different kfifo sample modules showing how to use the
102 generic kfifo API. 102 generic kfifo API.
103 103
104 If in doubt, say "N" here. 104 If in doubt, say "N" here.
105 105
106 config SAMPLE_KDB 106 config SAMPLE_KDB
107 tristate "Build kdb command example -- 107 tristate "Build kdb command example -- loadable modules only"
108 depends on KGDB_KDB && m 108 depends on KGDB_KDB && m
109 help 109 help
110 Build an example of how to dynamical 110 Build an example of how to dynamically add the hello
111 command to the kdb shell. 111 command to the kdb shell.
112 112
113 config SAMPLE_QMI_CLIENT 113 config SAMPLE_QMI_CLIENT
114 tristate "Build qmi client sample -- l 114 tristate "Build qmi client sample -- loadable modules only"
115 depends on m 115 depends on m
116 depends on ARCH_QCOM 116 depends on ARCH_QCOM
117 depends on NET 117 depends on NET
118 select QCOM_QMI_HELPERS 118 select QCOM_QMI_HELPERS
119 help 119 help
120 Build an QMI client sample driver, w 120 Build an QMI client sample driver, which demonstrates how to
121 communicate with a remote QRTR servi 121 communicate with a remote QRTR service, using QMI encoded messages.
122 122
123 config SAMPLE_RPMSG_CLIENT 123 config SAMPLE_RPMSG_CLIENT
124 tristate "Build rpmsg client sample -- 124 tristate "Build rpmsg client sample -- loadable modules only"
125 depends on RPMSG && m 125 depends on RPMSG && m
126 help 126 help
127 Build an rpmsg client sample driver, 127 Build an rpmsg client sample driver, which demonstrates how
128 to communicate with an AMP-configure 128 to communicate with an AMP-configured remote processor over
129 the rpmsg bus. 129 the rpmsg bus.
130 130
131 config SAMPLE_LIVEPATCH 131 config SAMPLE_LIVEPATCH
132 tristate "Build live patching samples 132 tristate "Build live patching samples -- loadable modules only"
133 depends on LIVEPATCH && m 133 depends on LIVEPATCH && m
134 help 134 help
135 Build sample live patch demonstratio 135 Build sample live patch demonstrations.
136 136
137 config SAMPLE_CONFIGFS 137 config SAMPLE_CONFIGFS
138 tristate "Build configfs patching samp 138 tristate "Build configfs patching sample -- loadable modules only"
139 depends on CONFIGFS_FS && m 139 depends on CONFIGFS_FS && m
140 help 140 help
141 Builds a sample configfs interface. 141 Builds a sample configfs interface.
142 142
143 config SAMPLE_CONNECTOR 143 config SAMPLE_CONNECTOR
144 tristate "Build connector sample -- lo 144 tristate "Build connector sample -- loadable modules only"
145 depends on CONNECTOR && HEADERS_INSTAL 145 depends on CONNECTOR && HEADERS_INSTALL && m
146 help 146 help
147 When enabled, this builds both a sam 147 When enabled, this builds both a sample kernel module for
148 the connector interface and a user s 148 the connector interface and a user space tool to communicate
149 with it. 149 with it.
150 See also Documentation/driver-api/co 150 See also Documentation/driver-api/connector.rst
151 151
152 config SAMPLE_FANOTIFY_ERROR 152 config SAMPLE_FANOTIFY_ERROR
153 bool "Build fanotify error monitoring 153 bool "Build fanotify error monitoring sample"
154 depends on FANOTIFY && CC_CAN_LINK && 154 depends on FANOTIFY && CC_CAN_LINK && HEADERS_INSTALL
155 help 155 help
156 When enabled, this builds an example 156 When enabled, this builds an example code that uses the
157 FAN_FS_ERROR fanotify mechanism to m 157 FAN_FS_ERROR fanotify mechanism to monitor filesystem
158 errors. 158 errors.
159 See also Documentation/admin-guide/f 159 See also Documentation/admin-guide/filesystem-monitoring.rst.
160 160
161 config SAMPLE_HIDRAW 161 config SAMPLE_HIDRAW
162 bool "hidraw sample" 162 bool "hidraw sample"
163 depends on CC_CAN_LINK && HEADERS_INST 163 depends on CC_CAN_LINK && HEADERS_INSTALL
164 164
165 config SAMPLE_LANDLOCK 165 config SAMPLE_LANDLOCK
166 bool "Landlock example" 166 bool "Landlock example"
167 depends on CC_CAN_LINK && HEADERS_INST 167 depends on CC_CAN_LINK && HEADERS_INSTALL
168 help 168 help
169 Build a simple Landlock sandbox mana 169 Build a simple Landlock sandbox manager able to start a process
170 restricted by a user-defined filesys 170 restricted by a user-defined filesystem access control policy.
171 171
172 config SAMPLE_PIDFD 172 config SAMPLE_PIDFD
173 bool "pidfd sample" 173 bool "pidfd sample"
174 depends on CC_CAN_LINK && HEADERS_INST 174 depends on CC_CAN_LINK && HEADERS_INSTALL
175 175
176 config SAMPLE_SECCOMP 176 config SAMPLE_SECCOMP
177 bool "Build seccomp sample code" 177 bool "Build seccomp sample code"
178 depends on SECCOMP_FILTER && CC_CAN_LI 178 depends on SECCOMP_FILTER && CC_CAN_LINK && HEADERS_INSTALL
179 help 179 help
180 Build samples of seccomp filters usi 180 Build samples of seccomp filters using various methods of
181 BPF filter construction. 181 BPF filter construction.
182 182
183 config SAMPLE_TIMER 183 config SAMPLE_TIMER
184 bool "Timer sample" 184 bool "Timer sample"
185 depends on CC_CAN_LINK && HEADERS_INST 185 depends on CC_CAN_LINK && HEADERS_INSTALL
186 186
187 config SAMPLE_UHID 187 config SAMPLE_UHID
188 bool "UHID sample" 188 bool "UHID sample"
189 depends on CC_CAN_LINK && HEADERS_INST 189 depends on CC_CAN_LINK && HEADERS_INSTALL
190 help 190 help
191 Build UHID sample program. 191 Build UHID sample program.
192 192
193 config SAMPLE_VFIO_MDEV_MTTY 193 config SAMPLE_VFIO_MDEV_MTTY
194 tristate "Build VFIO mtty example medi 194 tristate "Build VFIO mtty example mediated device sample code"
195 depends on VFIO 195 depends on VFIO
196 select VFIO_MDEV 196 select VFIO_MDEV
197 help 197 help
198 Build a virtual tty sample driver fo 198 Build a virtual tty sample driver for use as a VFIO
199 mediated device 199 mediated device
200 200
201 config SAMPLE_VFIO_MDEV_MDPY 201 config SAMPLE_VFIO_MDEV_MDPY
202 tristate "Build VFIO mdpy example medi 202 tristate "Build VFIO mdpy example mediated device sample code"
203 depends on VFIO 203 depends on VFIO
204 select VFIO_MDEV 204 select VFIO_MDEV
205 help 205 help
206 Build a virtual display sample drive 206 Build a virtual display sample driver for use as a VFIO
207 mediated device. It is a simple fra 207 mediated device. It is a simple framebuffer and supports
208 the region display interface (VFIO_G 208 the region display interface (VFIO_GFX_PLANE_TYPE_REGION).
209 209
210 config SAMPLE_VFIO_MDEV_MDPY_FB 210 config SAMPLE_VFIO_MDEV_MDPY_FB
211 tristate "Build VFIO mdpy example gues 211 tristate "Build VFIO mdpy example guest fbdev driver"
212 depends on FB 212 depends on FB
213 select FB_IOMEM_HELPERS !! 213 select FB_CFB_FILLRECT
>> 214 select FB_CFB_COPYAREA
>> 215 select FB_CFB_IMAGEBLIT
214 help 216 help
215 Guest fbdev driver for the virtual d 217 Guest fbdev driver for the virtual display sample driver.
216 218
217 config SAMPLE_VFIO_MDEV_MBOCHS 219 config SAMPLE_VFIO_MDEV_MBOCHS
218 tristate "Build VFIO mbochs example me 220 tristate "Build VFIO mbochs example mediated device sample code"
219 depends on VFIO 221 depends on VFIO
220 select VFIO_MDEV 222 select VFIO_MDEV
221 select DMA_SHARED_BUFFER 223 select DMA_SHARED_BUFFER
222 help 224 help
223 Build a virtual display sample drive 225 Build a virtual display sample driver for use as a VFIO
224 mediated device. It supports the re 226 mediated device. It supports the region display interface
225 (VFIO_GFX_PLANE_TYPE_DMABUF). 227 (VFIO_GFX_PLANE_TYPE_DMABUF).
226 Emulate enough of qemu stdvga to mak 228 Emulate enough of qemu stdvga to make bochs-drm.ko happy.
227 That is basically the vram memory ba 229 That is basically the vram memory bar and the bochs dispi
228 interface vbe registers in the mmio 230 interface vbe registers in the mmio register bar.
229 Specifically it does *not* include a 231 Specifically it does *not* include any legacy vga stuff.
230 Device looks a lot like "qemu -devic 232 Device looks a lot like "qemu -device secondary-vga".
231 233
232 config SAMPLE_ANDROID_BINDERFS 234 config SAMPLE_ANDROID_BINDERFS
233 bool "Build Android binderfs example" 235 bool "Build Android binderfs example"
234 depends on CC_CAN_LINK && HEADERS_INST 236 depends on CC_CAN_LINK && HEADERS_INSTALL
235 help 237 help
236 Builds a sample program to illustrat 238 Builds a sample program to illustrate the use of the Android binderfs
237 filesystem. 239 filesystem.
238 240
239 config SAMPLE_VFS 241 config SAMPLE_VFS
240 bool "Build example programs that use 242 bool "Build example programs that use new VFS system calls"
241 depends on CC_CAN_LINK && HEADERS_INST 243 depends on CC_CAN_LINK && HEADERS_INSTALL
242 help 244 help
243 Build example userspace programs tha 245 Build example userspace programs that use new VFS system calls such
244 as mount API and statx(). Note that 246 as mount API and statx(). Note that this is restricted to the x86
245 arch whilst it accesses system calls 247 arch whilst it accesses system calls that aren't yet in all arches.
246 248
247 config SAMPLE_INTEL_MEI 249 config SAMPLE_INTEL_MEI
248 bool "Build example program working wi 250 bool "Build example program working with intel mei driver"
249 depends on INTEL_MEI 251 depends on INTEL_MEI
250 depends on CC_CAN_LINK && HEADERS_INST 252 depends on CC_CAN_LINK && HEADERS_INSTALL
251 help 253 help
252 Build a sample program to work with 254 Build a sample program to work with mei device.
253 255
254 config SAMPLE_TPS6594_PFSM 256 config SAMPLE_TPS6594_PFSM
255 bool "Build example program working wi 257 bool "Build example program working with TPS6594 PFSM driver"
256 depends on HEADERS_INSTALL 258 depends on HEADERS_INSTALL
257 depends on CC_CAN_LINK 259 depends on CC_CAN_LINK
258 help 260 help
259 Build a sample program to work with 261 Build a sample program to work with PFSM devices.
260 262
261 config SAMPLE_WATCHDOG 263 config SAMPLE_WATCHDOG
262 bool "watchdog sample" 264 bool "watchdog sample"
263 depends on CC_CAN_LINK 265 depends on CC_CAN_LINK
264 266
265 config SAMPLE_WATCH_QUEUE 267 config SAMPLE_WATCH_QUEUE
266 bool "Build example watch_queue notifi 268 bool "Build example watch_queue notification API consumer"
267 depends on CC_CAN_LINK && HEADERS_INST 269 depends on CC_CAN_LINK && HEADERS_INSTALL
268 help 270 help
269 Build example userspace program to u 271 Build example userspace program to use the new mount_notify(),
270 sb_notify() syscalls and the KEYCTL_ 272 sb_notify() syscalls and the KEYCTL_WATCH_KEY keyctl() function.
271 273
272 config SAMPLE_CORESIGHT_SYSCFG 274 config SAMPLE_CORESIGHT_SYSCFG
273 tristate "Build example loadable modul 275 tristate "Build example loadable module for CoreSight config"
274 depends on CORESIGHT && m 276 depends on CORESIGHT && m
275 help 277 help
276 Build an example loadable module tha 278 Build an example loadable module that adds new CoreSight features
277 and configuration using the CoreSigh 279 and configuration using the CoreSight system configuration API.
278 This demonstrates how a user may cre 280 This demonstrates how a user may create their own CoreSight
279 configurations and easily load them 281 configurations and easily load them into the system at runtime.
280 282
281 config SAMPLE_KMEMLEAK 283 config SAMPLE_KMEMLEAK
282 tristate "Simple test for the kernel m 284 tristate "Simple test for the kernel memory leak detector"
283 depends on DEBUG_KMEMLEAK && m 285 depends on DEBUG_KMEMLEAK && m
284 help 286 help
285 Build a sample program which have ex 287 Build a sample program which have explicitly leaks memory to test
286 kmemleak 288 kmemleak
287 <<
288 config SAMPLE_CGROUP <<
289 bool "Build cgroup sample code" <<
290 depends on CGROUPS && CC_CAN_LINK && H <<
291 help <<
292 Build samples that demonstrate the u <<
293 289
294 source "samples/rust/Kconfig" 290 source "samples/rust/Kconfig"
295 291
296 endif # SAMPLES 292 endif # SAMPLES
297 293
298 config HAVE_SAMPLE_FTRACE_DIRECT 294 config HAVE_SAMPLE_FTRACE_DIRECT
299 bool 295 bool
300 296
301 config HAVE_SAMPLE_FTRACE_DIRECT_MULTI 297 config HAVE_SAMPLE_FTRACE_DIRECT_MULTI
302 bool 298 bool
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.