OLD | NEW |
(Empty) | |
| 1 /* |
| 2 * libudev - interface to udev device information |
| 3 * |
| 4 * Copyright (C) 2008-2011 Kay Sievers <kay.sievers@vrfy.org> |
| 5 * |
| 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. |
| 10 */ |
| 11 |
| 12 #ifndef _LIBUDEV_H_ |
| 13 #define _LIBUDEV_H_ |
| 14 |
| 15 #include <stdarg.h> |
| 16 #include <sys/types.h> |
| 17 #include <sys/stat.h> |
| 18 |
| 19 #ifdef __cplusplus |
| 20 extern "C" { |
| 21 #endif |
| 22 |
| 23 /* |
| 24 * udev - library context |
| 25 * |
| 26 * reads the udev config and system environment |
| 27 * allows custom logging |
| 28 */ |
| 29 struct udev; |
| 30 struct udev *udev_ref(struct udev *udev); |
| 31 struct udev *udev_unref(struct udev *udev); |
| 32 struct udev *udev_new(void); |
| 33 void udev_set_log_fn(struct udev *udev, |
| 34 void (*log_fn)(struct udev *udev, |
| 35 int priority, const char *file, int l
ine, const char *fn, |
| 36 const char *format, va_list args)); |
| 37 int udev_get_log_priority(struct udev *udev); |
| 38 void udev_set_log_priority(struct udev *udev, int priority); |
| 39 void *udev_get_userdata(struct udev *udev); |
| 40 void udev_set_userdata(struct udev *udev, void *userdata); |
| 41 |
| 42 /* |
| 43 * udev_list |
| 44 * |
| 45 * access to libudev generated lists |
| 46 */ |
| 47 struct udev_list_entry; |
| 48 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_en
try); |
| 49 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list
_entry, const char *name); |
| 50 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry); |
| 51 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry); |
| 52 /** |
| 53 * udev_list_entry_foreach: |
| 54 * @list_entry: entry to store the current position |
| 55 * @first_entry: first entry to start with |
| 56 * |
| 57 * Helper to iterate over all entries of a list. |
| 58 */ |
| 59 #define udev_list_entry_foreach(list_entry, first_entry) \ |
| 60 for (list_entry = first_entry; \ |
| 61 list_entry != NULL; \ |
| 62 list_entry = udev_list_entry_get_next(list_entry)) |
| 63 |
| 64 /* |
| 65 * udev_device |
| 66 * |
| 67 * access to sysfs/kernel devices |
| 68 */ |
| 69 struct udev_device; |
| 70 struct udev_device *udev_device_ref(struct udev_device *udev_device); |
| 71 struct udev_device *udev_device_unref(struct udev_device *udev_device); |
| 72 struct udev *udev_device_get_udev(struct udev_device *udev_device); |
| 73 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *
syspath); |
| 74 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, de
v_t devnum); |
| 75 struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, co
nst char *subsystem, const char *sysname); |
| 76 struct udev_device *udev_device_new_from_device_id(struct udev *udev, char *id); |
| 77 struct udev_device *udev_device_new_from_environment(struct udev *udev); |
| 78 /* udev_device_get_parent_*() does not take a reference on the returned device,
it is automatically unref'd with the parent */ |
| 79 struct udev_device *udev_device_get_parent(struct udev_device *udev_device); |
| 80 struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_de
vice *udev_device, |
| 81 const char *su
bsystem, const char *devtype); |
| 82 /* retrieve device properties */ |
| 83 const char *udev_device_get_devpath(struct udev_device *udev_device); |
| 84 const char *udev_device_get_subsystem(struct udev_device *udev_device); |
| 85 const char *udev_device_get_devtype(struct udev_device *udev_device); |
| 86 const char *udev_device_get_syspath(struct udev_device *udev_device); |
| 87 const char *udev_device_get_sysname(struct udev_device *udev_device); |
| 88 const char *udev_device_get_sysnum(struct udev_device *udev_device); |
| 89 const char *udev_device_get_devnode(struct udev_device *udev_device); |
| 90 int udev_device_get_is_initialized(struct udev_device *udev_device); |
| 91 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *
udev_device); |
| 92 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device
*udev_device); |
| 93 struct udev_list_entry *udev_device_get_tags_list_entry(struct udev_device *udev
_device); |
| 94 struct udev_list_entry *udev_device_get_sysattr_list_entry(struct udev_device *u
dev_device); |
| 95 const char *udev_device_get_property_value(struct udev_device *udev_device, cons
t char *key); |
| 96 const char *udev_device_get_driver(struct udev_device *udev_device); |
| 97 dev_t udev_device_get_devnum(struct udev_device *udev_device); |
| 98 const char *udev_device_get_action(struct udev_device *udev_device); |
| 99 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device); |
| 100 unsigned long long int udev_device_get_usec_since_initialized(struct udev_device
*udev_device); |
| 101 const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const
char *sysattr); |
| 102 int udev_device_has_tag(struct udev_device *udev_device, const char *tag); |
| 103 |
| 104 /* |
| 105 * udev_monitor |
| 106 * |
| 107 * access to kernel uevents and udev events |
| 108 */ |
| 109 struct udev_monitor; |
| 110 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor); |
| 111 struct udev_monitor *udev_monitor_unref(struct udev_monitor *udev_monitor); |
| 112 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor); |
| 113 /* kernel and udev generated events over netlink */ |
| 114 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char
*name); |
| 115 /* bind socket */ |
| 116 int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor); |
| 117 int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int
size); |
| 118 int udev_monitor_get_fd(struct udev_monitor *udev_monitor); |
| 119 struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monito
r); |
| 120 /* in-kernel socket filters to select messages that get delivered to a listener
*/ |
| 121 int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_mo
nitor, |
| 122 const char *subsystem, const
char *devtype); |
| 123 int udev_monitor_filter_add_match_tag(struct udev_monitor *udev_monitor, const c
har *tag); |
| 124 int udev_monitor_filter_update(struct udev_monitor *udev_monitor); |
| 125 int udev_monitor_filter_remove(struct udev_monitor *udev_monitor); |
| 126 |
| 127 /* |
| 128 * udev_enumerate |
| 129 * |
| 130 * search sysfs for specific devices and provide a sorted list |
| 131 */ |
| 132 struct udev_enumerate; |
| 133 struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate)
; |
| 134 struct udev_enumerate *udev_enumerate_unref(struct udev_enumerate *udev_enumerat
e); |
| 135 struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate); |
| 136 struct udev_enumerate *udev_enumerate_new(struct udev *udev); |
| 137 /* device properties filter */ |
| 138 int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, co
nst char *subsystem); |
| 139 int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate,
const char *subsystem); |
| 140 int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, cons
t char *sysattr, const char *value); |
| 141 int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, co
nst char *sysattr, const char *value); |
| 142 int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, con
st char *property, const char *value); |
| 143 int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, cons
t char *sysname); |
| 144 int udev_enumerate_add_match_tag(struct udev_enumerate *udev_enumerate, const ch
ar *tag); |
| 145 int udev_enumerate_add_match_parent(struct udev_enumerate *udev_enumerate, struc
t udev_device *parent); |
| 146 int udev_enumerate_add_match_is_initialized(struct udev_enumerate *udev_enumerat
e); |
| 147 int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char
*syspath); |
| 148 /* run enumeration with active filters */ |
| 149 int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate); |
| 150 int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate); |
| 151 /* return device list */ |
| 152 struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *ude
v_enumerate); |
| 153 |
| 154 /* |
| 155 * udev_queue |
| 156 * |
| 157 * access to the currently running udev events |
| 158 */ |
| 159 struct udev_queue; |
| 160 struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue); |
| 161 struct udev_queue *udev_queue_unref(struct udev_queue *udev_queue); |
| 162 struct udev *udev_queue_get_udev(struct udev_queue *udev_queue); |
| 163 struct udev_queue *udev_queue_new(struct udev *udev); |
| 164 unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queu
e); |
| 165 unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue)
; |
| 166 int udev_queue_get_udev_is_active(struct udev_queue *udev_queue); |
| 167 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue); |
| 168 int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned lo
ng long int seqnum); |
| 169 int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue, |
| 170 unsigned long long int start, uns
igned long long int end); |
| 171 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev
_queue); |
| 172 |
| 173 /* |
| 174 * udev_util |
| 175 * |
| 176 * udev specific utilities |
| 177 */ |
| 178 int udev_util_encode_string(const char *str, char *str_enc, size_t len); |
| 179 |
| 180 |
| 181 #ifdef __cplusplus |
| 182 } /* extern "C" */ |
| 183 #endif |
| 184 |
| 185 #endif |
OLD | NEW |