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