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 /* library context */
  25 struct udev;
  26 struct udev *udev_new(void);
  27 struct udev *udev_ref(struct udev *udev);
  28 void udev_unref(struct udev *udev);
  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 /* list iteration */
  41 struct udev_list_entry;
  42 struct udev_list_entry *udev_list_entry_get_next(struct udev_list_entry *list_entry);
  43 struct udev_list_entry *udev_list_entry_get_by_name(struct udev_list_entry *list_entry, const char *name);
  44 const char *udev_list_entry_get_name(struct udev_list_entry *list_entry);
  45 const char *udev_list_entry_get_value(struct udev_list_entry *list_entry);
  46 #define udev_list_entry_foreach(entry, first) \
  47         for (entry = first; \
  48              entry != NULL; \
  49              entry = udev_list_entry_get_next(entry))
  50
  51 /* sys devices */
  52 struct udev_device;
  53 struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
  54 struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
  55 struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname);
  56 struct udev_device *udev_device_get_parent(struct udev_device *udev_device);
  57 struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device, const char *subsystem, const char *devtype);
  58 struct udev_device *udev_device_ref(struct udev_device *udev_device);
  59 void udev_device_unref(struct udev_device *udev_device);
  60 struct udev *udev_device_get_udev(struct udev_device *udev_device);
  61 const char *udev_device_get_devpath(struct udev_device *udev_device);
  62 const char *udev_device_get_subsystem(struct udev_device *udev_device);
  63 const char *udev_device_get_devtype(struct udev_device *udev_device);
  64 const char *udev_device_get_syspath(struct udev_device *udev_device);
  65 const char *udev_device_get_sysname(struct udev_device *udev_device);
  66 const char *udev_device_get_sysnum(struct udev_device *udev_device);
  67 const char *udev_device_get_devnode(struct udev_device *udev_device);
  68 struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device);
  69 struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device);
  70 const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key);
  71 const char *udev_device_get_driver(struct udev_device *udev_device);
  72 dev_t udev_device_get_devnum(struct udev_device *udev_device);
  73 const char *udev_device_get_action(struct udev_device *udev_device);
  74 unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
  75 const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr);
  76
  77 /* device events */
  78 struct udev_monitor;
  79 struct udev_monitor *udev_monitor_new_from_netlink(struct udev *udev, const char *name);
  80 struct udev_monitor *udev_monitor_new_from_socket(struct udev *udev, const char *socket_path);
  81 int udev_monitor_enable_receiving(struct udev_monitor *udev_monitor);
  82 struct udev_monitor *udev_monitor_ref(struct udev_monitor *udev_monitor);
  83 void udev_monitor_unref(struct udev_monitor *udev_monitor);
  84 struct udev *udev_monitor_get_udev(struct udev_monitor *udev_monitor);
  85 int udev_monitor_get_fd(struct udev_monitor *udev_monitor);
  86 struct udev_device *udev_monitor_receive_device(struct udev_monitor *udev_monitor);
  87 int udev_monitor_filter_add_match_subsystem_devtype(struct udev_monitor *udev_monitor, const char *subsystem, const char *devtype);
  88 int udev_monitor_filter_update(struct udev_monitor *udev_monitor);
  89 int udev_monitor_filter_remove(struct udev_monitor *udev_monitor);
  90
  91 /* sys enumeration */
  92 struct udev_enumerate;
  93 struct udev_enumerate *udev_enumerate_new(struct udev *udev);
  94 struct udev_enumerate *udev_enumerate_ref(struct udev_enumerate *udev_enumerate);
  95 void udev_enumerate_unref(struct udev_enumerate *udev_enumerate);
  96 struct udev *udev_enumerate_get_udev(struct udev_enumerate *udev_enumerate);
  97 int udev_enumerate_add_match_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
  98 int udev_enumerate_add_nomatch_subsystem(struct udev_enumerate *udev_enumerate, const char *subsystem);
  99 int udev_enumerate_add_match_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
 100 int udev_enumerate_add_nomatch_sysattr(struct udev_enumerate *udev_enumerate, const char *sysattr, const char *value);
 101 int udev_enumerate_add_match_property(struct udev_enumerate *udev_enumerate, const char *property, const char *value);
 102 int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath);
 103 int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate);
 104 int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate);
 105 struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate);
 106
 107 /* event queue */
 108 struct udev_queue;
 109 struct udev_queue *udev_queue_new(struct udev *udev);
 110 struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue);
 111 void udev_queue_unref(struct udev_queue *udev_queue);
 112 struct udev *udev_queue_get_udev(struct udev_queue *udev_queue);
 113 unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue);
 114 unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue);
 115 int udev_queue_get_udev_is_active(struct udev_queue *udev_queue);
 116 int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue);
 117 int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum);
 118 int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
 119                                                unsigned long long int start, unsigned long long int end);
 120 struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue);
 121 struct udev_list_entry *udev_queue_get_failed_list_entry(struct udev_queue *udev_queue);
 122 #endif