1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2 #ifndef foosddevicehfoo
3 #define foosddevicehfoo
4 
5 /***
6   systemd is free software; you can redistribute it and/or modify it
7   under the terms of the GNU Lesser General Public License as published by
8   the Free Software Foundation; either version 2.1 of the License, or
9   (at your option) any later version.
10 
11   systemd is distributed in the hope that it will be useful, but
12   WITHOUT ANY WARRANTY; without even the implied warranty of
13   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14   Lesser General Public License for more details.
15 
16   You should have received a copy of the GNU Lesser General Public License
17   along with systemd; If not, see <http://www.gnu.org/licenses/>.
18 ***/
19 
20 #include <errno.h>
21 #include <inttypes.h>
22 #include <sys/stat.h>
23 #include <sys/sysmacros.h>
24 #include <sys/types.h>
25 
26 #include "sd-event.h"
27 #include "sd-id128.h"
28 
29 #include "_sd-common.h"
30 
31 _SD_BEGIN_DECLARATIONS;
32 
33 typedef struct sd_device sd_device;
34 typedef struct sd_device_enumerator sd_device_enumerator;
35 typedef struct sd_device_monitor sd_device_monitor;
36 
37 typedef enum sd_device_action_t {
38         SD_DEVICE_ADD,
39         SD_DEVICE_REMOVE,
40         SD_DEVICE_CHANGE,
41         SD_DEVICE_MOVE,
42         SD_DEVICE_ONLINE,
43         SD_DEVICE_OFFLINE,
44         SD_DEVICE_BIND,
45         SD_DEVICE_UNBIND,
46         _SD_DEVICE_ACTION_MAX,
47         _SD_DEVICE_ACTION_INVALID = -EINVAL,
48         _SD_ENUM_FORCE_S64(DEVICE_ACTION),
49 } sd_device_action_t;
50 
51 /* callback */
52 
53 typedef int (*sd_device_monitor_handler_t)(sd_device_monitor *m, sd_device *device, void *userdata);
54 
55 /* device */
56 
57 sd_device *sd_device_ref(sd_device *device);
58 sd_device *sd_device_unref(sd_device *device);
59 
60 int sd_device_new_from_syspath(sd_device **ret, const char *syspath);
61 int sd_device_new_from_devnum(sd_device **ret, char type, dev_t devnum);
62 int sd_device_new_from_subsystem_sysname(sd_device **ret, const char *subsystem, const char *sysname);
63 int sd_device_new_from_device_id(sd_device **ret, const char *id);
64 int sd_device_new_from_stat_rdev(sd_device **ret, const struct stat *st);
65 int sd_device_new_from_devname(sd_device **ret, const char *devname);
66 int sd_device_new_from_path(sd_device **ret, const char *path);
67 int sd_device_new_from_ifname(sd_device **ret, const char *ifname);
68 int sd_device_new_from_ifindex(sd_device **ret, int ifindex);
69 
70 int sd_device_get_parent(sd_device *child, sd_device **ret);
71 int sd_device_get_parent_with_subsystem_devtype(sd_device *child, const char *subsystem, const char *devtype, sd_device **ret);
72 
73 int sd_device_get_syspath(sd_device *device, const char **ret);
74 int sd_device_get_subsystem(sd_device *device, const char **ret);
75 int sd_device_get_devtype(sd_device *device, const char **ret);
76 int sd_device_get_devnum(sd_device *device, dev_t *devnum);
77 int sd_device_get_ifindex(sd_device *device, int *ifindex);
78 int sd_device_get_driver(sd_device *device, const char **ret);
79 int sd_device_get_devpath(sd_device *device, const char **ret);
80 int sd_device_get_devname(sd_device *device, const char **ret);
81 int sd_device_get_sysname(sd_device *device, const char **ret);
82 int sd_device_get_sysnum(sd_device *device, const char **ret);
83 int sd_device_get_action(sd_device *device, sd_device_action_t *ret);
84 int sd_device_get_seqnum(sd_device *device, uint64_t *ret);
85 int sd_device_get_diskseq(sd_device *device, uint64_t *ret);
86 
87 int sd_device_get_is_initialized(sd_device *device);
88 int sd_device_get_usec_initialized(sd_device *device, uint64_t *usec);
89 int sd_device_get_usec_since_initialized(sd_device *device, uint64_t *usec);
90 
91 const char *sd_device_get_tag_first(sd_device *device);
92 const char *sd_device_get_tag_next(sd_device *device);
93 const char *sd_device_get_current_tag_first(sd_device *device);
94 const char *sd_device_get_current_tag_next(sd_device *device);
95 const char *sd_device_get_devlink_first(sd_device *device);
96 const char *sd_device_get_devlink_next(sd_device *device);
97 const char *sd_device_get_property_first(sd_device *device, const char **value);
98 const char *sd_device_get_property_next(sd_device *device, const char **value);
99 const char *sd_device_get_sysattr_first(sd_device *device);
100 const char *sd_device_get_sysattr_next(sd_device *device);
101 
102 int sd_device_has_tag(sd_device *device, const char *tag);
103 int sd_device_has_current_tag(sd_device *device, const char *tag);
104 int sd_device_get_property_value(sd_device *device, const char *key, const char **value);
105 int sd_device_get_trigger_uuid(sd_device *device, sd_id128_t *ret);
106 int sd_device_get_sysattr_value(sd_device *device, const char *sysattr, const char **_value);
107 
108 int sd_device_set_sysattr_value(sd_device *device, const char *sysattr, const char *value);
109 int sd_device_set_sysattr_valuef(sd_device *device, const char *sysattr, const char *format, ...) _sd_printf_(3, 4);
110 int sd_device_trigger(sd_device *device, sd_device_action_t action);
111 int sd_device_trigger_with_uuid(sd_device *device, sd_device_action_t action, sd_id128_t *ret_uuid);
112 int sd_device_open(sd_device *device, int flags);
113 
114 /* device enumerator */
115 
116 int sd_device_enumerator_new(sd_device_enumerator **ret);
117 sd_device_enumerator *sd_device_enumerator_ref(sd_device_enumerator *enumerator);
118 sd_device_enumerator *sd_device_enumerator_unref(sd_device_enumerator *enumerator);
119 
120 sd_device *sd_device_enumerator_get_device_first(sd_device_enumerator *enumerator);
121 sd_device *sd_device_enumerator_get_device_next(sd_device_enumerator *enumerator);
122 sd_device *sd_device_enumerator_get_subsystem_first(sd_device_enumerator *enumerator);
123 sd_device *sd_device_enumerator_get_subsystem_next(sd_device_enumerator *enumerator);
124 
125 int sd_device_enumerator_add_match_subsystem(sd_device_enumerator *enumerator, const char *subsystem, int match);
126 int sd_device_enumerator_add_match_sysattr(sd_device_enumerator *enumerator, const char *sysattr, const char *value, int match);
127 int sd_device_enumerator_add_match_property(sd_device_enumerator *enumerator, const char *property, const char *value);
128 int sd_device_enumerator_add_match_sysname(sd_device_enumerator *enumerator, const char *sysname);
129 int sd_device_enumerator_add_nomatch_sysname(sd_device_enumerator *enumerator, const char *sysname);
130 int sd_device_enumerator_add_match_tag(sd_device_enumerator *enumerator, const char *tag);
131 int sd_device_enumerator_add_match_parent(sd_device_enumerator *enumerator, sd_device *parent);
132 int sd_device_enumerator_allow_uninitialized(sd_device_enumerator *enumerator);
133 
134 /* device monitor */
135 
136 int sd_device_monitor_new(sd_device_monitor **ret);
137 sd_device_monitor *sd_device_monitor_ref(sd_device_monitor *m);
138 sd_device_monitor *sd_device_monitor_unref(sd_device_monitor *m);
139 
140 int sd_device_monitor_set_receive_buffer_size(sd_device_monitor *m, size_t size);
141 int sd_device_monitor_attach_event(sd_device_monitor *m, sd_event *event);
142 int sd_device_monitor_detach_event(sd_device_monitor *m);
143 sd_event *sd_device_monitor_get_event(sd_device_monitor *m);
144 sd_event_source *sd_device_monitor_get_event_source(sd_device_monitor *m);
145 int sd_device_monitor_start(sd_device_monitor *m, sd_device_monitor_handler_t callback, void *userdata);
146 int sd_device_monitor_stop(sd_device_monitor *m);
147 
148 int sd_device_monitor_filter_add_match_subsystem_devtype(sd_device_monitor *m, const char *subsystem, const char *devtype);
149 int sd_device_monitor_filter_add_match_tag(sd_device_monitor *m, const char *tag);
150 int sd_device_monitor_filter_add_match_sysattr(sd_device_monitor *m, const char *sysattr, const char *value, int match);
151 int sd_device_monitor_filter_add_match_parent(sd_device_monitor *m, sd_device *device, int match);
152 int sd_device_monitor_filter_update(sd_device_monitor *m);
153 int sd_device_monitor_filter_remove(sd_device_monitor *m);
154 
155 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_device, sd_device_unref);
156 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_device_enumerator, sd_device_enumerator_unref);
157 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_device_monitor, sd_device_monitor_unref);
158 
159 _SD_END_DECLARATIONS;
160 
161 #endif
162