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