libudev/libudev.h

   1 /*
   2  * libudev - interface to udev device information
   3  *
   4  * Copyright (C) 2008-2009 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 /*
  20  * udev - library context
  21  *
  22  * reads the udev config and system environment
  23  * allows custom logging
  24  */
  25 struct udev;
  26 struct udev *udev_ref(struct udev *udev);
  27 void udev_unref(struct udev *udev);
  28 struct udev *udev_new(void);
  29 void udev_set_log_fn(struct udev *udev,
  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));
  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);
  39
  40 /*
  41  * udev_list
  42  *
  43  * access to libudev generated lists
  44  */
  45 struct udev_list_entry;
  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);
  50 #define udev_list_entry_foreach(entry, first) \
  51         for (entry = first; \
  52              entry != NULL; \
  53              entry = udev_list_entry_get_next(entry))
  54
  55 /*
  56  * udev_device
  57  *
  58  * access to sysfs/kernel devices
  59  */
  60 struct udev_device;
  61 struct udev_device *udev_device_ref(struct udev_device *udev_device);
  62 void udev_device_unref(struct udev_device *udev_device);
  63 struct udev *udev_device_get_udev(struct udev_device *udev_device);
  64 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
  65 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
  66 struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname);
  67 /* udev_device_get_parent_*() does not take a reference on the returned device, it is automatically unref'd with the parent */
  68 struct udev_device *udev_device_get_parent(struct udev_device *udev_device);
  69 struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device,
  70                                                                   const char *subsystem, const char *devtype);
  71 /* retrieve device properties */
  72 const char *udev_device_get_devpath(struct udev_device *udev_device);
  73 const char *udev_device_get_subsystem(struct udev_device *udev_device);
  74 const char *udev_device_get_devtype(struct udev_device *udev_device);
  75 const char *udev_device_get_syspath(struct udev_device *udev_device);
  76 const char *udev_device_get_sysname(struct udev_device *udev_device);
  77 const char *udev_device_get_sysnum(struct udev_device *udev_device);
  78 const char *udev_device_get_devnode(struct udev_device *udev_device);
  79 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device);
  80 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device);
  81 const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key);
  82 const char *udev_device_get_driver(struct udev_device *udev_device);
  83 dev_t udev_device_get_devnum(struct udev_device *udev_device);
  84 const char *udev_device_get_action(struct udev_device *udev_device);
  85 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
  86 const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr);
  87
  88 /*
  89  * udev_monitor
  90  *
  91  * access to kernel uevents and udev events
  92  */
  93 struct udev_monitor;
  94 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor);
  95 void udev_monitor_unref(struct udev_monitor *udev_monitor);
  96 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor);
  97 /* kernel and udev generated events over netlink */
  98 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name);
  99 /* custom socket (use netlink and filters instead) */
 100 struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path);
 101 /* bind socket */
 102 int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor);
 103 int udev_monitor_get_fd(struct udev_monitor *udev_monitor);
 104 struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor);
 105 /* in-kernel socket filters to select messages that get delivered to a listener */
 106 int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor,
 107                                                     const char *subsystem, const char *devtype);
 108 int udev_monitor_filter_update(struct udev_monitor *udev_monitor);
 109 int udev_monitor_filter_remove(struct udev_monitor *udev_monitor);
 110
 111 /*
 112  * udev_enumerate
 113  *
 114  * search sysfs for specific devices and provide a sorted list
 115  */
 116 struct udev_enumerate;
 117 struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate);
 118 void udev_enumerate_unref(struct udev_enumerate *udev_enumerate);
 119 struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate);
 120 struct udev_enumerate *udev_enumerate_new(struct udev *udev);
 121 /* device properties filter */
 122 int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
 123 int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
 124 int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
 125 int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
 126 int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value);
 127 int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath);
 128 /* run enumeration with active filters */
 129 int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate);
 130 int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate);
 131 /* return device list */
 132 struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate);
 133
 134 /*
 135  * udev_queue
 136  *
 137  * access to the currently running udev events
 138  */
 139 struct udev_queue;
 140 struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue);
 141 void udev_queue_unref(struct udev_queue *udev_queue);
 142 struct udev *udev_queue_get_udev(struct udev_queue *udev_queue);
 143 struct udev_queue *udev_queue_new(struct udev *udev);
 144 unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue);
 145 unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue);
 146 int udev_queue_get_udev_is_active(struct udev_queue *udev_queue);
 147 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue);
 148 int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum);
 149 int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
 150                                                unsigned long long int start, unsigned long long int end);
 151 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue);
 152 struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev_queue);
 153 #endif