]>
Commit | Line | Data |
---|---|---|
53e1b683 | 1 | /* SPDX-License-Identifier: LGPL-2.1+ */ |
88a6477e | 2 | /*** |
96b2fb93 | 3 | Copyright © 2008-2012 Kay Sievers <kay@vrfy.org> |
88a6477e | 4 | ***/ |
33a5cc29 KS |
5 | |
6 | #ifndef _LIBUDEV_H_ | |
7 | #define _LIBUDEV_H_ | |
8 | ||
7d563a17 | 9 | #include <stdarg.h> |
27d13af7 | 10 | #include <sys/sysmacros.h> |
4f06aaa9 | 11 | #include <sys/types.h> |
7d563a17 | 12 | |
3fac12b9 DE |
13 | #ifdef __cplusplus |
14 | extern "C" { | |
15 | #endif | |
16 | ||
15a45c89 KS |
17 | /* |
18 | * udev - library context | |
ad29a9f1 | 19 | * |
15a45c89 KS |
20 | * reads the udev config and system environment |
21 | * allows custom logging | |
22 | */ | |
0de33a61 | 23 | struct udev; |
37ed4f56 | 24 | struct udev *udev_ref(struct udev *udev); |
20bbd54f | 25 | struct udev *udev_unref(struct udev *udev); |
15a45c89 | 26 | struct udev *udev_new(void); |
37ed4f56 | 27 | void udev_set_log_fn(struct udev *udev, |
912541b0 KS |
28 | void (*log_fn)(struct udev *udev, |
29 | int priority, const char *file, int line, const char *fn, | |
25e773ee KS |
30 | const char *format, va_list args)) __attribute__ ((deprecated)); |
31 | int udev_get_log_priority(struct udev *udev) __attribute__ ((deprecated)); | |
32 | void udev_set_log_priority(struct udev *udev, int priority) __attribute__ ((deprecated)); | |
37ed4f56 KS |
33 | void *udev_get_userdata(struct udev *udev); |
34 | void udev_set_userdata(struct udev *udev, void *userdata); | |
c8e32461 | 35 | |
15a45c89 KS |
36 | /* |
37 | * udev_list | |
38 | * | |
39 | * access to libudev generated lists | |
40 | */ | |
0de33a61 | 41 | struct udev_list_entry; |
37ed4f56 KS |
42 | struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry); |
43 | struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name); | |
44 | const char *udev_list_entry_get_name(struct udev_list_entry *list_entry); | |
45 | const char *udev_list_entry_get_value(struct udev_list_entry *list_entry); | |
1e511322 KS |
46 | /** |
47 | * udev_list_entry_foreach: | |
48 | * @list_entry: entry to store the current position | |
49 | * @first_entry: first entry to start with | |
50 | * | |
51 | * Helper to iterate over all entries of a list. | |
52 | */ | |
53 | #define udev_list_entry_foreach(list_entry, first_entry) \ | |
912541b0 KS |
54 | for (list_entry = first_entry; \ |
55 | list_entry != NULL; \ | |
56 | list_entry = udev_list_entry_get_next(list_entry)) | |
bf7ad0ea | 57 | |
15a45c89 KS |
58 | /* |
59 | * udev_device | |
60 | * | |
61 | * access to sysfs/kernel devices | |
62 | */ | |
0de33a61 | 63 | struct udev_device; |
15a45c89 | 64 | struct udev_device *udev_device_ref(struct udev_device *udev_device); |
20bbd54f | 65 | struct udev_device *udev_device_unref(struct udev_device *udev_device); |
15a45c89 | 66 | struct udev *udev_device_get_udev(struct udev_device *udev_device); |
37ed4f56 KS |
67 | struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath); |
68 | struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum); | |
69 | struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname); | |
67410e9f | 70 | struct udev_device *udev_device_new_from_device_id(struct udev *udev, const char *id); |
fc8d61c5 | 71 | struct udev_device *udev_device_new_from_environment(struct udev *udev); |
15a45c89 | 72 | /* udev_device_get_parent_*() does not take a reference on the returned device, it is automatically unref'd with the parent */ |
37ed4f56 | 73 | struct udev_device *udev_device_get_parent(struct udev_device *udev_device); |
15a45c89 | 74 | struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device, |
912541b0 | 75 | const char *subsystem, const char *devtype); |
15a45c89 | 76 | /* retrieve device properties */ |
37ed4f56 KS |
77 | const char *udev_device_get_devpath(struct udev_device *udev_device); |
78 | const char *udev_device_get_subsystem(struct udev_device *udev_device); | |
79 | const char *udev_device_get_devtype(struct udev_device *udev_device); | |
80 | const char *udev_device_get_syspath(struct udev_device *udev_device); | |
81 | const char *udev_device_get_sysname(struct udev_device *udev_device); | |
82 | const char *udev_device_get_sysnum(struct udev_device *udev_device); | |
83 | const char *udev_device_get_devnode(struct udev_device *udev_device); | |
48a0170b | 84 | int udev_device_get_is_initialized(struct udev_device *udev_device); |
37ed4f56 KS |
85 | struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device); |
86 | struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device); | |
2793f4e3 | 87 | struct udev_list_entry *udev_device_get_tags_list_entry(struct udev_device *udev_device); |
f180ad25 | 88 | struct udev_list_entry *udev_device_get_sysattr_list_entry(struct udev_device *udev_device); |
37ed4f56 KS |
89 | const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key); |
90 | const char *udev_device_get_driver(struct udev_device *udev_device); | |
91 | dev_t udev_device_get_devnum(struct udev_device *udev_device); | |
92 | const char *udev_device_get_action(struct udev_device *udev_device); | |
93 | unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device); | |
9c6a11b1 | 94 | unsigned long long int udev_device_get_usec_since_initialized(struct udev_device *udev_device); |
37ed4f56 | 95 | const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr); |
946f1825 | 96 | int udev_device_set_sysattr_value(struct udev_device *udev_device, const char *sysattr, char *value); |
b59c22a7 | 97 | int udev_device_has_tag(struct udev_device *udev_device, const char *tag); |
33a5cc29 | 98 | |
15a45c89 KS |
99 | /* |
100 | * udev_monitor | |
101 | * | |
102 | * access to kernel uevents and udev events | |
103 | */ | |
0de33a61 | 104 | struct udev_monitor; |
37ed4f56 | 105 | struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor); |
20bbd54f | 106 | struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor); |
37ed4f56 | 107 | struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor); |
15a45c89 KS |
108 | /* kernel and udev generated events over netlink */ |
109 | struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name); | |
15a45c89 KS |
110 | /* bind socket */ |
111 | int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor); | |
a571c23e | 112 | int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size); |
37ed4f56 KS |
113 | int udev_monitor_get_fd(struct udev_monitor *udev_monitor); |
114 | struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor); | |
15a45c89 KS |
115 | /* in-kernel socket filters to select messages that get delivered to a listener */ |
116 | int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor, | |
912541b0 | 117 | const char *subsystem, const char *devtype); |
28460195 | 118 | int udev_monitor_filter_add_match_tag(struct udev_monitor *udev_monitor, const char *tag); |
37ed4f56 KS |
119 | int udev_monitor_filter_update(struct udev_monitor *udev_monitor); |
120 | int udev_monitor_filter_remove(struct udev_monitor *udev_monitor); | |
ba6929f6 | 121 | |
15a45c89 KS |
122 | /* |
123 | * udev_enumerate | |
124 | * | |
125 | * search sysfs for specific devices and provide a sorted list | |
126 | */ | |
0de33a61 | 127 | struct udev_enumerate; |
37ed4f56 | 128 | struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate); |
20bbd54f | 129 | struct udev_enumerate *udev_enumerate_unref(struct udev_enumerate *udev_enumerate); |
37ed4f56 | 130 | struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate); |
15a45c89 KS |
131 | struct udev_enumerate *udev_enumerate_new(struct udev *udev); |
132 | /* device properties filter */ | |
37ed4f56 KS |
133 | int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem); |
134 | int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem); | |
135 | int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value); | |
136 | int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value); | |
137 | int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value); | |
cf5bd040 | 138 | int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, const char *sysname); |
28460195 | 139 | int udev_enumerate_add_match_tag(struct udev_enumerate *udev_enumerate, const char *tag); |
b05211fa | 140 | int udev_enumerate_add_match_parent(struct udev_enumerate *udev_enumerate, struct udev_device *parent); |
48a0170b | 141 | int udev_enumerate_add_match_is_initialized(struct udev_enumerate *udev_enumerate); |
37ed4f56 | 142 | int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath); |
15a45c89 | 143 | /* run enumeration with active filters */ |
37ed4f56 KS |
144 | int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate); |
145 | int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate); | |
15a45c89 | 146 | /* return device list */ |
37ed4f56 | 147 | struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate); |
0de33a61 | 148 | |
15a45c89 KS |
149 | /* |
150 | * udev_queue | |
151 | * | |
152 | * access to the currently running udev events | |
153 | */ | |
64ccdf82 | 154 | struct udev_queue; |
37ed4f56 | 155 | struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue); |
20bbd54f | 156 | struct udev_queue *udev_queue_unref(struct udev_queue *udev_queue); |
37ed4f56 | 157 | struct udev *udev_queue_get_udev(struct udev_queue *udev_queue); |
15a45c89 | 158 | struct udev_queue *udev_queue_new(struct udev *udev); |
9ea28c55 KS |
159 | unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue) __attribute__ ((deprecated)); |
160 | unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue) __attribute__ ((deprecated)); | |
37ed4f56 KS |
161 | int udev_queue_get_udev_is_active(struct udev_queue *udev_queue); |
162 | int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue); | |
9ea28c55 | 163 | int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum) __attribute__ ((deprecated)); |
f503f6b2 | 164 | int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue, |
9ea28c55 | 165 | unsigned long long int start, unsigned long long int end) __attribute__ ((deprecated)); |
14cb7336 KS |
166 | int udev_queue_get_fd(struct udev_queue *udev_queue); |
167 | int udev_queue_flush(struct udev_queue *udev_queue); | |
9ea28c55 | 168 | struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue) __attribute__ ((deprecated)); |
3fac12b9 | 169 | |
2001208c KS |
170 | /* |
171 | * udev_hwdb | |
172 | * | |
173 | * access to the static hardware properties database | |
174 | */ | |
175 | struct udev_hwdb; | |
176 | struct udev_hwdb *udev_hwdb_new(struct udev *udev); | |
177 | struct udev_hwdb *udev_hwdb_ref(struct udev_hwdb *hwdb); | |
178 | struct udev_hwdb *udev_hwdb_unref(struct udev_hwdb *hwdb); | |
179 | struct udev_list_entry *udev_hwdb_get_properties_list_entry(struct udev_hwdb *hwdb, const char *modalias, unsigned int flags); | |
180 | ||
0bbe8838 KS |
181 | /* |
182 | * udev_util | |
183 | * | |
184 | * udev specific utilities | |
185 | */ | |
186 | int udev_util_encode_string(const char *str, char *str_enc, size_t len); | |
187 | ||
3fac12b9 DE |
188 | #ifdef __cplusplus |
189 | } /* extern "C" */ | |
190 | #endif | |
191 | ||
33a5cc29 | 192 | #endif |