libudev0.h 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189
  1. /*
  2. * libudev - interface to udev device information
  3. *
  4. * Copyright (C) 2008-2011 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. #ifndef _LIBUDEV_H_
  12. #define _LIBUDEV_H_
  13. #include <stdarg.h>
  14. #include <sys/types.h>
  15. #include <sys/stat.h>
  16. #ifdef __cplusplus
  17. extern "C" {
  18. #endif
  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. const char *udev_get_run_path(struct udev *udev);
  38. void *udev_get_userdata(struct udev *udev);
  39. void udev_set_userdata(struct udev *udev, void *userdata);
  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. /**
  51. * udev_list_entry_foreach:
  52. * @list_entry: entry to store the current position
  53. * @first_entry: first entry to start with
  54. *
  55. * Helper to iterate over all entries of a list.
  56. */
  57. #define udev_list_entry_foreach(list_entry, first_entry) \
  58. for (list_entry = first_entry; \
  59. list_entry != NULL; \
  60. list_entry = udev_list_entry_get_next(list_entry))
  61. /*
  62. * udev_device
  63. *
  64. * access to sysfs/kernel devices
  65. */
  66. struct udev_device;
  67. struct udev_device *udev_device_ref(struct udev_device *udev_device);
  68. void udev_device_unref(struct udev_device *udev_device);
  69. struct udev *udev_device_get_udev(struct udev_device *udev_device);
  70. struct udev_device *udev_device_new_from_syspath(struct udev *udev, const char *syspath);
  71. struct udev_device *udev_device_new_from_devnum(struct udev *udev, char type, dev_t devnum);
  72. struct udev_device *udev_device_new_from_subsystem_sysname(struct udev *udev, const char *subsystem, const char *sysname);
  73. struct udev_device *udev_device_new_from_environment(struct udev *udev);
  74. /* udev_device_get_parent_*() does not take a reference on the returned device, it is automatically unref'd with the parent */
  75. struct udev_device *udev_device_get_parent(struct udev_device *udev_device);
  76. struct udev_device *udev_device_get_parent_with_subsystem_devtype(struct udev_device *udev_device,
  77. const char *subsystem, const char *devtype);
  78. /* retrieve device properties */
  79. const char *udev_device_get_devpath(struct udev_device *udev_device);
  80. const char *udev_device_get_subsystem(struct udev_device *udev_device);
  81. const char *udev_device_get_devtype(struct udev_device *udev_device);
  82. const char *udev_device_get_syspath(struct udev_device *udev_device);
  83. const char *udev_device_get_sysname(struct udev_device *udev_device);
  84. const char *udev_device_get_sysnum(struct udev_device *udev_device);
  85. const char *udev_device_get_devnode(struct udev_device *udev_device);
  86. int udev_device_get_is_initialized(struct udev_device *udev_device);
  87. struct udev_list_entry *udev_device_get_devlinks_list_entry(struct udev_device *udev_device);
  88. struct udev_list_entry *udev_device_get_properties_list_entry(struct udev_device *udev_device);
  89. struct udev_list_entry *udev_device_get_tags_list_entry(struct udev_device *udev_device);
  90. struct udev_list_entry *udev_device_get_sysattr_list_entry(struct udev_device *udev_device);
  91. const char *udev_device_get_property_value(struct udev_device *udev_device, const char *key);
  92. const char *udev_device_get_driver(struct udev_device *udev_device);
  93. dev_t udev_device_get_devnum(struct udev_device *udev_device);
  94. const char *udev_device_get_action(struct udev_device *udev_device);
  95. unsigned long long int udev_device_get_seqnum(struct udev_device *udev_device);
  96. unsigned long long int udev_device_get_usec_since_initialized(struct udev_device *udev_device);
  97. const char *udev_device_get_sysattr_value(struct udev_device *udev_device, const char *sysattr);
  98. int udev_device_has_tag(struct udev_device *udev_device, const char *tag);
  99. /*
  100. * udev_monitor
  101. *
  102. * access to kernel uevents and udev events
  103. */
  104. struct udev_monitor;
  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);
  112. /* bind socket */
  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_add_match_tag(struct udev_monitor *udev_monitor, const char *tag);
  121. int udev_monitor_filter_update(struct udev_monitor *udev_monitor);
  122. int udev_monitor_filter_remove(struct udev_monitor *udev_monitor);
  123. /*
  124. * udev_enumerate
  125. *
  126. * search sysfs for specific devices and provide a sorted list
  127. */
  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_match_tag(struct udev_enumerate *udev_enumerate, const char *tag);
  141. int udev_enumerate_add_match_parent(struct udev_enumerate *udev_enumerate, struct udev_device *parent);
  142. int udev_enumerate_add_match_is_initialized(struct udev_enumerate *udev_enumerate);
  143. int udev_enumerate_add_syspath(struct udev_enumerate *udev_enumerate, const char *syspath);
  144. /* run enumeration with active filters */
  145. int udev_enumerate_scan_devices(struct udev_enumerate *udev_enumerate);
  146. int udev_enumerate_scan_subsystems(struct udev_enumerate *udev_enumerate);
  147. /* return device list */
  148. struct udev_list_entry *udev_enumerate_get_list_entry(struct udev_enumerate *udev_enumerate);
  149. /*
  150. * udev_queue
  151. *
  152. * access to the currently running udev events
  153. */
  154. struct udev_queue;
  155. struct udev_queue *udev_queue_ref(struct udev_queue *udev_queue);
  156. void udev_queue_unref(struct udev_queue *udev_queue);
  157. struct udev *udev_queue_get_udev(struct udev_queue *udev_queue);
  158. struct udev_queue *udev_queue_new(struct udev *udev);
  159. unsigned long long int udev_queue_get_kernel_seqnum(struct udev_queue *udev_queue);
  160. unsigned long long int udev_queue_get_udev_seqnum(struct udev_queue *udev_queue);
  161. int udev_queue_get_udev_is_active(struct udev_queue *udev_queue);
  162. int udev_queue_get_queue_is_empty(struct udev_queue *udev_queue);
  163. int udev_queue_get_seqnum_is_finished(struct udev_queue *udev_queue, unsigned long long int seqnum);
  164. int udev_queue_get_seqnum_sequence_is_finished(struct udev_queue *udev_queue,
  165. unsigned long long int start, unsigned long long int end);
  166. struct udev_list_entry *udev_queue_get_queued_list_entry(struct udev_queue *udev_queue);
  167. /*
  168. * udev_util
  169. *
  170. * udev specific utilities
  171. */
  172. int udev_util_encode_string(const char *str, char *str_enc, size_t len);
  173. #ifdef __cplusplus
  174. } /* extern "C" */
  175. #endif
  176. #endif