samples/Kconfig

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