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