xref: /linux/rust/bindings/bindings_helper.h (revision f5e9d31e79c1ce8ba948ecac74d75e9c8d2f0c87)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * Header that contains the code (mostly headers) for which Rust bindings
4  * will be automatically generated by `bindgen`.
5  *
6  * Sorted alphabetically.
7  */
8 
9 /*
10  * First, avoid forward references to `enum` types.
11  *
12  * This workarounds a `bindgen` issue with them:
13  * <https://github.com/rust-lang/rust-bindgen/issues/3179>.
14  *
15  * Without this, the generated Rust type may be the wrong one (`i32`) or
16  * the proper one (typically `c_uint`) depending on how the headers are
17  * included, which in turn may depend on the particular kernel configuration
18  * or the architecture.
19  *
20  * The alternative would be to use casts and likely an
21  * `#[allow(clippy::unnecessary_cast)]` in the Rust source files. Instead,
22  * this approach allows us to keep the correct code in the source files and
23  * simply remove this section when the issue is fixed upstream and we bump
24  * the minimum `bindgen` version.
25  *
26  * This workaround may not be possible in some cases, depending on how the C
27  * headers are set up.
28  */
29 #include <linux/hrtimer_types.h>
30 
31 #include <linux/acpi.h>
32 #include <drm/drm_device.h>
33 #include <drm/drm_drv.h>
34 #include <drm/drm_file.h>
35 #include <drm/drm_gem.h>
36 #include <drm/drm_ioctl.h>
37 #include <kunit/test.h>
38 #include <linux/auxiliary_bus.h>
39 #include <linux/bitmap.h>
40 #include <linux/blk-mq.h>
41 #include <linux/blk_types.h>
42 #include <linux/blkdev.h>
43 #include <linux/clk.h>
44 #include <linux/completion.h>
45 #include <linux/configfs.h>
46 #include <linux/cpu.h>
47 #include <linux/cpufreq.h>
48 #include <linux/cpumask.h>
49 #include <linux/cred.h>
50 #include <linux/debugfs.h>
51 #include <linux/device/faux.h>
52 #include <linux/dma-direction.h>
53 #include <linux/dma-mapping.h>
54 #include <linux/errname.h>
55 #include <linux/ethtool.h>
56 #include <linux/fdtable.h>
57 #include <linux/file.h>
58 #include <linux/firmware.h>
59 #include <linux/interrupt.h>
60 #include <linux/fs.h>
61 #include <linux/i2c.h>
62 #include <linux/ioport.h>
63 #include <linux/jiffies.h>
64 #include <linux/jump_label.h>
65 #include <linux/mdio.h>
66 #include <linux/mm.h>
67 #include <linux/miscdevice.h>
68 #include <linux/of_device.h>
69 #include <linux/pci.h>
70 #include <linux/phy.h>
71 #include <linux/pid_namespace.h>
72 #include <linux/platform_device.h>
73 #include <linux/pm_opp.h>
74 #include <linux/poll.h>
75 #include <linux/property.h>
76 #include <linux/pwm.h>
77 #include <linux/random.h>
78 #include <linux/refcount.h>
79 #include <linux/regulator/consumer.h>
80 #include <linux/sched.h>
81 #include <linux/security.h>
82 #include <linux/slab.h>
83 #include <linux/task_work.h>
84 #include <linux/tracepoint.h>
85 #include <linux/usb.h>
86 #include <linux/wait.h>
87 #include <linux/workqueue.h>
88 #include <linux/xarray.h>
89 #include <trace/events/rust_sample.h>
90 
91 /*
92  * The driver-core Rust code needs to know about some C driver-core private
93  * structures.
94  */
95 #include <../../drivers/base/base.h>
96 
97 #if defined(CONFIG_DRM_PANIC_SCREEN_QR_CODE)
98 // Used by `#[export]` in `drivers/gpu/drm/drm_panic_qr.rs`.
99 #include <drm/drm_panic.h>
100 #endif
101 
102 /* `bindgen` gets confused at certain things. */
103 const size_t RUST_CONST_HELPER_ARCH_SLAB_MINALIGN = ARCH_SLAB_MINALIGN;
104 const size_t RUST_CONST_HELPER_ARCH_KMALLOC_MINALIGN = ARCH_KMALLOC_MINALIGN;
105 const size_t RUST_CONST_HELPER_PAGE_SIZE = PAGE_SIZE;
106 const gfp_t RUST_CONST_HELPER_GFP_ATOMIC = GFP_ATOMIC;
107 const gfp_t RUST_CONST_HELPER_GFP_KERNEL = GFP_KERNEL;
108 const gfp_t RUST_CONST_HELPER_GFP_KERNEL_ACCOUNT = GFP_KERNEL_ACCOUNT;
109 const gfp_t RUST_CONST_HELPER_GFP_NOWAIT = GFP_NOWAIT;
110 const gfp_t RUST_CONST_HELPER___GFP_ZERO = __GFP_ZERO;
111 const gfp_t RUST_CONST_HELPER___GFP_HIGHMEM = ___GFP_HIGHMEM;
112 const gfp_t RUST_CONST_HELPER___GFP_NOWARN = ___GFP_NOWARN;
113 const blk_features_t RUST_CONST_HELPER_BLK_FEAT_ROTATIONAL = BLK_FEAT_ROTATIONAL;
114 const fop_flags_t RUST_CONST_HELPER_FOP_UNSIGNED_OFFSET = FOP_UNSIGNED_OFFSET;
115 
116 const xa_mark_t RUST_CONST_HELPER_XA_PRESENT = XA_PRESENT;
117 
118 const gfp_t RUST_CONST_HELPER_XA_FLAGS_ALLOC = XA_FLAGS_ALLOC;
119 const gfp_t RUST_CONST_HELPER_XA_FLAGS_ALLOC1 = XA_FLAGS_ALLOC1;
120 
121 const vm_flags_t RUST_CONST_HELPER_VM_MERGEABLE = VM_MERGEABLE;
122 const vm_flags_t RUST_CONST_HELPER_VM_READ = VM_READ;
123 const vm_flags_t RUST_CONST_HELPER_VM_WRITE = VM_WRITE;
124 const vm_flags_t RUST_CONST_HELPER_VM_EXEC = VM_EXEC;
125 const vm_flags_t RUST_CONST_HELPER_VM_SHARED = VM_SHARED;
126 const vm_flags_t RUST_CONST_HELPER_VM_MAYREAD = VM_MAYREAD;
127 const vm_flags_t RUST_CONST_HELPER_VM_MAYWRITE = VM_MAYWRITE;
128 const vm_flags_t RUST_CONST_HELPER_VM_MAYEXEC = VM_MAYEXEC;
129 const vm_flags_t RUST_CONST_HELPER_VM_MAYSHARE = VM_MAYEXEC;
130 const vm_flags_t RUST_CONST_HELPER_VM_PFNMAP = VM_PFNMAP;
131 const vm_flags_t RUST_CONST_HELPER_VM_IO = VM_IO;
132 const vm_flags_t RUST_CONST_HELPER_VM_DONTCOPY = VM_DONTCOPY;
133 const vm_flags_t RUST_CONST_HELPER_VM_DONTEXPAND = VM_DONTEXPAND;
134 const vm_flags_t RUST_CONST_HELPER_VM_LOCKONFAULT = VM_LOCKONFAULT;
135 const vm_flags_t RUST_CONST_HELPER_VM_ACCOUNT = VM_ACCOUNT;
136 const vm_flags_t RUST_CONST_HELPER_VM_NORESERVE = VM_NORESERVE;
137 const vm_flags_t RUST_CONST_HELPER_VM_HUGETLB = VM_HUGETLB;
138 const vm_flags_t RUST_CONST_HELPER_VM_SYNC = VM_SYNC;
139 const vm_flags_t RUST_CONST_HELPER_VM_ARCH_1 = VM_ARCH_1;
140 const vm_flags_t RUST_CONST_HELPER_VM_WIPEONFORK = VM_WIPEONFORK;
141 const vm_flags_t RUST_CONST_HELPER_VM_DONTDUMP = VM_DONTDUMP;
142 const vm_flags_t RUST_CONST_HELPER_VM_SOFTDIRTY = VM_SOFTDIRTY;
143 const vm_flags_t RUST_CONST_HELPER_VM_MIXEDMAP = VM_MIXEDMAP;
144 const vm_flags_t RUST_CONST_HELPER_VM_HUGEPAGE = VM_HUGEPAGE;
145 const vm_flags_t RUST_CONST_HELPER_VM_NOHUGEPAGE = VM_NOHUGEPAGE;
146 
147 #if IS_ENABLED(CONFIG_ANDROID_BINDER_IPC_RUST)
148 #include "../../drivers/android/binder/rust_binder.h"
149 #include "../../drivers/android/binder/rust_binder_events.h"
150 #include "../../drivers/android/binder/page_range_helper.h"
151 #endif
152