Training courses

Kernel and Embedded Linux

Bootlin training courses

Embedded Linux, kernel,
Yocto Project, Buildroot, real-time,
graphics, boot time, debugging...

Bootlin logo

Elixir Cross Referencer

# SPDX-License-Identifier: GPL-2.0-only
menuconfig CONFIG_SAMPLES
	bool "Sample kernel code"
	help
	  You can build and test sample kernel code here.

if CONFIG_SAMPLES

config CONFIG_SAMPLE_TRACE_EVENTS
	tristate "Build trace_events examples -- loadable modules only"
	depends on CONFIG_EVENT_TRACING && m
	help
	  This build trace event example modules.

config CONFIG_SAMPLE_TRACE_PRINTK
        tristate "Build trace_printk module - tests various trace_printk formats"
	depends on CONFIG_EVENT_TRACING && m
	help
	 This builds a module that calls trace_printk() and can be used to
	 test various trace_printk() calls from a module.

config CONFIG_SAMPLE_KOBJECT
	tristate "Build kobject examples"
	help
	  This config option will allow you to build a number of
	  different kobject sample modules showing how to use kobjects,
	  ksets, and ktypes properly.

	  If in doubt, say "N" here.

config CONFIG_SAMPLE_KPROBES
	tristate "Build kprobes examples -- loadable modules only"
	depends on CONFIG_KPROBES && m
	help
	  This build several kprobes example modules.

config CONFIG_SAMPLE_KRETPROBES
	tristate "Build kretprobes example -- loadable modules only"
	default m
	depends on CONFIG_SAMPLE_KPROBES && CONFIG_KRETPROBES

config CONFIG_SAMPLE_HW_BREAKPOINT
	tristate "Build kernel hardware breakpoint examples -- loadable module only"
	depends on CONFIG_HAVE_HW_BREAKPOINT && m
	help
	  This builds kernel hardware breakpoint example modules.

config CONFIG_SAMPLE_KFIFO
	tristate "Build kfifo examples -- loadable modules only"
	depends on m
	help
	  This config option will allow you to build a number of
	  different kfifo sample modules showing how to use the
	  generic kfifo API.

	  If in doubt, say "N" here.

config CONFIG_SAMPLE_KDB
	tristate "Build kdb command example -- loadable modules only"
	depends on CONFIG_KGDB_KDB && m
	help
	  Build an example of how to dynamically add the hello
	  command to the kdb shell.

config CONFIG_SAMPLE_QMI_CLIENT
	tristate "Build qmi client sample -- loadable modules only"
	depends on m
	depends on CONFIG_ARCH_QCOM
	depends on CONFIG_NET
	select CONFIG_QCOM_QMI_HELPERS
	help
	  Build an QMI client sample driver, which demonstrates how to
	  communicate with a remote CONFIG_QRTR service, using QMI encoded messages.

config CONFIG_SAMPLE_RPMSG_CLIENT
	tristate "Build rpmsg client sample -- loadable modules only"
	depends on CONFIG_RPMSG && m
	help
	  Build an rpmsg client sample driver, which demonstrates how
	  to communicate with an AMP-configured remote processor over
	  the rpmsg bus.

config CONFIG_SAMPLE_LIVEPATCH
	tristate "Build live patching samples -- loadable modules only"
	depends on CONFIG_LIVEPATCH && m
	help
	  Build sample live patch demonstrations.

config CONFIG_SAMPLE_CONFIGFS
	tristate "Build configfs patching sample -- loadable modules only"
	depends on CONFIG_CONFIGFS_FS && m
	help
	  Builds a sample configfs interface.

config CONFIG_SAMPLE_CONNECTOR
	tristate "Build connector sample -- loadable modules only"
	depends on CONFIG_CONNECTOR && CONFIG_HEADERS_INSTALL && m
	help
	  When enabled, this builds both a sample kernel module for
	  the connector interface and a user space tool to communicate
	  with it.
	  See also Documentation/driver-api/connector.rst

config CONFIG_SAMPLE_HIDRAW
	bool "hidraw sample"
	depends on CONFIG_HEADERS_INSTALL

config CONFIG_SAMPLE_PIDFD
	bool "pidfd sample"
	depends on CONFIG_HEADERS_INSTALL

config CONFIG_SAMPLE_SECCOMP
	bool "Build seccomp sample code"
	depends on CONFIG_SECCOMP_FILTER && CONFIG_HEADERS_INSTALL
	help
	  Build samples of seccomp filters using various methods of
	  CONFIG_BPF filter construction.

config CONFIG_SAMPLE_VFIO_MDEV_MTTY
	tristate "Build VFIO mtty example mediated device sample code -- loadable modules only"
	depends on CONFIG_VFIO_MDEV_DEVICE && m
	help
	  Build a virtual tty sample driver for use as a CONFIG_VFIO
	  mediated device

config CONFIG_SAMPLE_VFIO_MDEV_MDPY
	tristate "Build VFIO mdpy example mediated device sample code -- loadable modules only"
	depends on CONFIG_VFIO_MDEV_DEVICE && m
	help
	  Build a virtual display sample driver for use as a CONFIG_VFIO
	  mediated device.  It is a simple framebuffer and supports
	  the region display interface (VFIO_GFX_PLANE_TYPE_REGION).

config CONFIG_SAMPLE_VFIO_MDEV_MDPY_FB
	tristate "Build VFIO mdpy example guest fbdev driver -- loadable module only"
	depends on CONFIG_FB && m
	select CONFIG_FB_CFB_FILLRECT
	select CONFIG_FB_CFB_COPYAREA
	select CONFIG_FB_CFB_IMAGEBLIT
	help
	  Guest fbdev driver for the virtual display sample driver.

config CONFIG_SAMPLE_VFIO_MDEV_MBOCHS
	tristate "Build VFIO mdpy example mediated device sample code -- loadable modules only"
	depends on CONFIG_VFIO_MDEV_DEVICE && m
	select CONFIG_DMA_SHARED_BUFFER
	help
	  Build a virtual display sample driver for use as a CONFIG_VFIO
	  mediated device.  It supports the region display interface
	  (VFIO_GFX_PLANE_TYPE_DMABUF).
	  Emulate enough of qemu stdvga to make bochs-drm.ko happy.
	  That is basically the vram memory bar and the bochs dispi
	  interface vbe registers in the mmio register bar.
	  Specifically it does *not* include any legacy vga stuff.
	  Device looks a lot like "qemu -device secondary-vga".

config CONFIG_SAMPLE_ANDROID_BINDERFS
	bool "Build Android binderfs example"
	depends on CONFIG_ANDROID_BINDERFS
	help
	  Builds a sample program to illustrate the use of the Android binderfs
	  filesystem.

config CONFIG_SAMPLE_VFS
	bool "Build example programs that use new VFS system calls"
	depends on CONFIG_HEADERS_INSTALL
	help
	  Build example userspace programs that use new VFS system calls such
	  as mount API and statx().  Note that this is restricted to the x86
	  arch whilst it accesses system calls that aren't yet in all arches.

endif # CONFIG_SAMPLES