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