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