]>
Commit | Line | Data |
---|---|---|
33a5cc29 KS |
1 | /* |
2 | * libudev - interface to udev device information | |
3 | * | |
a25d547d | 4 | * Copyright (C) 2008-2009 Kay Sievers <kay.sievers@vrfy.org> |
33a5cc29 | 5 | * |
4061ab9f KS |
6 | * This library is free software; you can redistribute it and/or |
7 | * modify it under the terms of the GNU Lesser General Public | |
8 | * License as published by the Free Software Foundation; either | |
9 | * version 2.1 of the License, or (at your option) any later version. | |
33a5cc29 KS |
10 | */ |
11 | ||
12 | #ifndef _LIBUDEV_H_ | |
13 | #define _LIBUDEV_H_ | |
14 | ||
7d563a17 | 15 | #include <stdarg.h> |
4f06aaa9 | 16 | #include <sys/types.h> |
c4f5f942 | 17 | #include <sys/stat.h> |
7d563a17 | 18 | |
15a45c89 KS |
19 | /* |
20 | * udev - library context | |
21 | * | |
22 | * reads the udev config and system environment | |
23 | * allows custom logging | |
24 | */ | |
0de33a61 | 25 | struct udev; |
37ed4f56 KS |
26 | struct udev *udev_ref(struct udev *udev); |
27 | void udev_unref(struct udev *udev); | |
15a45c89 | 28 | struct udev *udev_new(void); |
37ed4f56 | 29 | void udev_set_log_fn(struct udev *udev, |
33a5cc29 KS |
30 | void (*log_fn)(struct udev *udev, |
31 | int priority, const char *file, int line, const char *fn, | |
32 | const char *format, va_list args)); | |
37ed4f56 KS |
33 | int udev_get_log_priority(struct udev *udev); |
34 | void udev_set_log_priority(struct udev *udev, int priority); | |
35 | const char *udev_get_sys_path(struct udev *udev); | |
36 | const char *udev_get_dev_path(struct udev *udev); | |
37 | void *udev_get_userdata(struct udev *udev); | |
38 | void udev_set_userdata(struct udev *udev, void *userdata); | |
c8e32461 | 39 | |
15a45c89 KS |
40 | /* |
41 | * udev_list | |
42 | * | |
43 | * access to libudev generated lists | |
44 | */ | |
0de33a61 | 45 | struct udev_list_entry; |
37ed4f56 KS |
46 | struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry); |
47 | struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name); | |
48 | const char *udev_list_entry_get_name(struct udev_list_entry *list_entry); | |
49 | const char *udev_list_entry_get_value(struct udev_list_entry *list_entry); | |
1e511322 KS |
50 | /** |
51 | * udev_list_entry_foreach: | |
52 | * @list_entry: entry to store the current position | |
53 | * @first_entry: first entry to start with | |
54 | * | |
55 | * Helper to iterate over all entries of a list. | |
56 | */ | |
57 | #define udev_list_entry_foreach(list_entry, first_entry) \ | |
58 | for (list_entry = first_entry; \ | |
59 | list_entry != NULL; \ | |
60 | list_entry = udev_list_entry_get_next(list_entry)) | |
bf7ad0ea | 61 | |
15a45c89 KS |
62 | /* |
63 | * udev_device | |
64 | * | |
65 | * access to sysfs/kernel devices | |
66 | */ | |
0de33a61 | 67 | struct udev_device; |
15a45c89 KS |
68 | struct udev_device *udev_device_ref(struct udev_device *udev_device); |
69 | void udev_device_unref(struct udev_device *udev_device); | |
70 | struct udev *udev_device_get_udev(struct udev_device *udev_device); | |
37ed4f56 KS |
71 | struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath); |
72 | struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum); | |
73 | struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname); | |
15a45c89 | 74 | /* udev_device_get_parent_*() does not take a reference on the returned device, it is automatically unref'd with the parent */ |
37ed4f56 | 75 | struct udev_device *udev_device_get_parent(struct udev_device *udev_device); |
15a45c89 KS |
76 | struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device, |
77 | const char *subsystem, const char *devtype); | |
78 | /* retrieve device properties */ | |
37ed4f56 KS |
79 | const char *udev_device_get_devpath(struct udev_device *udev_device); |
80 | const char *udev_device_get_subsystem(struct udev_device *udev_device); | |
81 | const char *udev_device_get_devtype(struct udev_device *udev_device); | |
82 | const char *udev_device_get_syspath(struct udev_device *udev_device); | |
83 | const char *udev_device_get_sysname(struct udev_device *udev_device); | |
84 | const char *udev_device_get_sysnum(struct udev_device *udev_device); | |
85 | const char *udev_device_get_devnode(struct udev_device *udev_device); | |
86 | struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device); | |
87 | struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device); | |
88 | const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key); | |
89 | const char *udev_device_get_driver(struct udev_device *udev_device); | |
90 | dev_t udev_device_get_devnum(struct udev_device *udev_device); | |
91 | const char *udev_device_get_action(struct udev_device *udev_device); | |
92 | unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device); | |
93 | const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr); | |
33a5cc29 | 94 | |
15a45c89 KS |
95 | /* |
96 | * udev_monitor | |
97 | * | |
98 | * access to kernel uevents and udev events | |
99 | */ | |
0de33a61 | 100 | struct udev_monitor; |
37ed4f56 KS |
101 | struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor); |
102 | void udev_monitor_unref(struct udev_monitor *udev_monitor); | |
103 | struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor); | |
15a45c89 KS |
104 | /* kernel and udev generated events over netlink */ |
105 | struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name); | |
106 | /* custom socket (use netlink and filters instead) */ | |
107 | struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path); | |
108 | /* bind socket */ | |
109 | int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor); | |
37ed4f56 KS |
110 | int udev_monitor_get_fd(struct udev_monitor *udev_monitor); |
111 | struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor); | |
15a45c89 KS |
112 | /* in-kernel socket filters to select messages that get delivered to a listener */ |
113 | int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor, | |
114 | const char *subsystem, const char *devtype); | |
37ed4f56 KS |
115 | int udev_monitor_filter_update(struct udev_monitor *udev_monitor); |
116 | int udev_monitor_filter_remove(struct udev_monitor *udev_monitor); | |
ba6929f6 | 117 | |
15a45c89 KS |
118 | /* |
119 | * udev_enumerate | |
120 | * | |
121 | * search sysfs for specific devices and provide a sorted list | |
122 | */ | |
0de33a61 | 123 | struct udev_enumerate; |
37ed4f56 KS |
124 | struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate); |
125 | void udev_enumerate_unref(struct udev_enumerate *udev_enumerate); | |
126 | struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate); | |
15a45c89 KS |
127 | struct udev_enumerate *udev_enumerate_new(struct udev *udev); |
128 | /* device properties filter */ | |
37ed4f56 KS |
129 | int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem); |
130 | int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem); | |
131 | int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value); | |
132 | int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value); | |
133 | int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value); | |
cf5bd040 | 134 | int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, const char *sysname); |
37ed4f56 | 135 | int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath); |
15a45c89 | 136 | /* run enumeration with active filters */ |
37ed4f56 KS |
137 | int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate); |
138 | int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate); | |
15a45c89 | 139 | /* return device list */ |
37ed4f56 | 140 | struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate); |
0de33a61 | 141 | |
15a45c89 KS |
142 | /* |
143 | * udev_queue | |
144 | * | |
145 | * access to the currently running udev events | |
146 | */ | |
64ccdf82 | 147 | struct udev_queue; |
37ed4f56 KS |
148 | struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue); |
149 | void udev_queue_unref(struct udev_queue *udev_queue); | |
150 | struct udev *udev_queue_get_udev(struct udev_queue *udev_queue); | |
15a45c89 | 151 | struct udev_queue *udev_queue_new(struct udev *udev); |
37ed4f56 KS |
152 | unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue); |
153 | unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue); | |
154 | int udev_queue_get_udev_is_active(struct udev_queue *udev_queue); | |
155 | int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue); | |
156 | int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum); | |
f503f6b2 AJ |
157 | int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue, |
158 | unsigned long long int start, unsigned long long int end); | |
37ed4f56 KS |
159 | struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue); |
160 | struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev_queue); | |
33a5cc29 | 161 | #endif |