2 * libudev - interface to udev device information
4 * Copyright (C) 2008-2009 Kay Sievers <kay.sievers@vrfy.org>
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.
16 #include <sys/types.h>
24 * udev - library context
26 * reads the udev config and system environment
27 * allows custom logging
30 struct udev *udev_ref(struct udev *udev);
31 void 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 line, 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 const char *udev_get_sys_path(struct udev *udev);
40 const char *udev_get_dev_path(struct udev *udev);
41 void *udev_get_userdata(struct udev *udev);
42 void udev_set_userdata(struct udev *udev, void *userdata);
47 * access to libudev generated lists
49 struct udev_list_entry;
50 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry);
51 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name);
52 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry);
53 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry);
55 * udev_list_entry_foreach:
56 * @list_entry: entry to store the current position
57 * @first_entry: first entry to start with
59 * Helper to iterate over all entries of a list.
61 #define udev_list_entry_foreach(list_entry, first_entry) \
62 for (list_entry = first_entry; \
64 list_entry = udev_list_entry_get_next(list_entry))
69 * access to sysfs/kernel devices
72 struct udev_device *udev_device_ref(struct udev_device *udev_device);
73 void udev_device_unref(struct udev_device *udev_device);
74 struct udev *udev_device_get_udev(struct udev_device *udev_device);
75 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
76 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
77 struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname);
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_device *udev_device,
81 const char *subsystem, 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 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device);
91 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device);
92 const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key);
93 const char *udev_device_get_driver(struct udev_device *udev_device);
94 dev_t udev_device_get_devnum(struct udev_device *udev_device);
95 const char *udev_device_get_action(struct udev_device *udev_device);
96 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
97 const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr);
102 * access to kernel uevents and udev events
105 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor);
106 void udev_monitor_unref(struct udev_monitor *udev_monitor);
107 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor);
108 /* kernel and udev generated events over netlink */
109 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name);
110 /* custom socket (use netlink and filters instead) */
111 struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path);
113 int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor);
114 int udev_monitor_set_receive_buffer_size(struct udev_monitor *udev_monitor, int size);
115 int udev_monitor_get_fd(struct udev_monitor *udev_monitor);
116 struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor);
117 /* in-kernel socket filters to select messages that get delivered to a listener */
118 int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor,
119 const char *subsystem, const char *devtype);
120 int udev_monitor_filter_update(struct udev_monitor *udev_monitor);
121 int udev_monitor_filter_remove(struct udev_monitor *udev_monitor);
126 * search sysfs for specific devices and provide a sorted list
128 struct udev_enumerate;
129 struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate);
130 void udev_enumerate_unref(struct udev_enumerate *udev_enumerate);
131 struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate);
132 struct udev_enumerate *udev_enumerate_new(struct udev *udev);
133 /* device properties filter */
134 int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
135 int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
136 int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
137 int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
138 int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value);
139 int udev_enumerate_add_match_sysname(struct udev_enumerate *udev_enumerate, const char *sysname);
140 int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath);
141 /* run enumeration with active filters */
142 int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate);
143 int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate);
144 /* return device list */
145 struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate);
150 * access to the currently running udev events
153 struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue);
154 void udev_queue_unref(struct udev_queue *udev_queue);
155 struct udev *udev_queue_get_udev(struct udev_queue *udev_queue);
156 struct udev_queue *udev_queue_new(struct udev *udev);
157 unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue);
158 unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue);
159 int udev_queue_get_udev_is_active(struct udev_queue *udev_queue);
160 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue);
161 int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum);
162 int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
163 unsigned long long int start, unsigned long long int end);
164 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue);
165 struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev_queue);