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