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

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