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