udev/lib/libudev.h

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008 Kay Sievers <kay.sievers@vrfy.org>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef _LIBUDEV_H_
  21 #define _LIBUDEV_H_
  22
  23 #include <stdarg.h>
  24 #include <sys/stat.h>
  25
  26 /* this will stay as long as the DeviceKit integration of udev is work in progress */
  27 #if !defined _LIBUDEV_COMPILATION && !defined LIBUDEV_I_KNOW_THE_API_IS_SUBJECT_TO_CHANGE
  28 #error "#define LIBUDEV_I_KNOW_THE_API_IS_SUBJECT_TO_CHANGE is needed to use this experimental library version"
  29 #endif
  30
  31 /* library context */
  32 struct udev;
  33 extern struct udev *udev_new(void);
  34 extern struct udev *udev_ref(struct udev *udev);
  35 extern void udev_unref(struct udev *udev);
  36 extern void udev_set_log_fn(struct udev *udev,
  37                             void (*log_fn)(struct udev *udev,
  38                                            int priority, const char *file, int line, const char *fn,
  39                                            const char *format, va_list args));
  40 extern int udev_get_log_priority(struct udev *udev);
  41 extern void udev_set_log_priority(struct udev *udev, int priority);
  42 extern const char *udev_get_sys_path(struct udev *udev);
  43 extern const char *udev_get_dev_path(struct udev *udev);
  44 extern void *udev_get_userdata(struct udev *udev);
  45 extern void udev_set_userdata(struct udev *udev, void *userdata);
  46
  47 /* list iteration */
  48 struct udev_list_entry;
  49 extern struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry);
  50 extern struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name);
  51 extern const char *udev_list_entry_get_name(struct udev_list_entry *list_entry);
  52 extern const char *udev_list_entry_get_value(struct udev_list_entry *list_entry);
  53 #define udev_list_entry_foreach(entry, first) \
  54         for (entry = first; \
  55              entry != NULL; \
  56              entry = udev_list_entry_get_next(entry))
  57
  58 /* sys devices */
  59 struct udev_device;
  60 extern struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
  61 extern struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
  62 extern struct udev_device *udev_device_get_parent(struct udev_device *udev_device);
  63 extern struct udev_device *udev_device_ref(struct udev_device *udev_device);
  64 extern void udev_device_unref(struct udev_device *udev_device);
  65 extern struct udev *udev_device_get_udev(struct udev_device *udev_device);
  66 extern const char *udev_device_get_devpath(struct udev_device *udev_device);
  67 extern const char *udev_device_get_subsystem(struct udev_device *udev_device);
  68 extern const char *udev_device_get_syspath(struct udev_device *udev_device);
  69 extern const char *udev_device_get_sysname(struct udev_device *udev_device);
  70 extern const char *udev_device_get_devnode(struct udev_device *udev_device);
  71 extern struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device);
  72 extern struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device);
  73 extern const char *udev_device_get_driver(struct udev_device *udev_device);
  74 extern dev_t udev_device_get_devnum(struct udev_device *udev_device);
  75 extern const char *udev_device_get_action(struct udev_device *udev_device);
  76 extern unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
  77 extern const char *udev_device_get_attr_value(struct udev_device *udev_device, const char *attr);
  78
  79 /* udev and kernel device events */
  80 struct udev_monitor;
  81 extern struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path);
  82 extern struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev);
  83 extern int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor);
  84 extern struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor);
  85 extern void udev_monitor_unref(struct udev_monitor *udev_monitor);
  86 extern struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor);
  87 extern int udev_monitor_get_fd(struct udev_monitor *udev_monitor);
  88 extern struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor);
  89
  90 /* sys enumeration */
  91 struct udev_enumerate;
  92 extern struct udev_enumerate *udev_enumerate_new(struct udev *udev);
  93 extern struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate);
  94 extern void udev_enumerate_unref(struct udev_enumerate *udev_enumerate);
  95 extern struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate);
  96 extern int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
  97 extern int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
  98 extern int udev_enumerate_add_match_attr(struct udev_enumerate *udev_enumerate, const char *attr, const char *value);
  99 extern int udev_enumerate_add_nomatch_attr(struct udev_enumerate *udev_enumerate, const char *attr, const char *value);
 100 extern int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath);
 101 extern int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate);
 102 extern int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate);
 103 extern struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate);
 104
 105 /* event queue */
 106 struct udev_queue;
 107 extern struct udev_queue *udev_queue_new(struct udev *udev);
 108 extern struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue);
 109 extern void udev_queue_unref(struct udev_queue *udev_queue);
 110 extern struct udev *udev_queue_get_udev(struct udev_queue *udev_queue);
 111 extern unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue);
 112 extern unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue);
 113 extern int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue);
 114 extern int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum);
 115 extern struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue);
 116 extern struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev_queue);
 117 #endif