2 This file is part of PulseAudio.
4 Copyright 2009 Lennart Poettering
6 PulseAudio is free software; you can redistribute it and/or modify
7 it under the terms of the GNU Lesser General Public License as
8 published by the Free Software Foundation; either version 2.1 of the
9 License, or (at your option) any later version.
11 PulseAudio 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 General Public License for more details.
16 You should have received a copy of the GNU Lesser General Public
17 License along with PulseAudio; if not, write to the Free Software
18 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
28 #include <sys/inotify.h>
31 #include <pulsecore/modargs.h>
32 #include <pulsecore/core-error.h>
33 #include <pulsecore/core-util.h>
34 #include <pulsecore/namereg.h>
36 #include "module-udev-detect-symdef.h"
38 PA_MODULE_AUTHOR("Lennart Poettering");
39 PA_MODULE_DESCRIPTION("Detect available audio hardware and load matching drivers");
40 PA_MODULE_VERSION(PACKAGE_VERSION
);
41 PA_MODULE_LOAD_ONCE(TRUE
);
43 "tsched=<enable system timer based scheduling mode?> "
44 "ignore_dB=<ignore dB information from the device?>");
48 pa_bool_t accessible
:1;
49 pa_bool_t need_verify
:1;
59 pa_bool_t use_tsched
:1;
60 pa_bool_t ignore_dB
:1;
63 struct udev_monitor
*monitor
;
67 pa_io_event
*inotify_io
;
70 static const char* const valid_modargs
[] = {
76 static int setup_inotify(struct userdata
*u
);
78 static void device_free(struct device
*d
) {
82 pa_xfree(d
->card_name
);
87 static const char *path_get_card_id(const char *path
) {
93 if (!(e
= strrchr(path
, '/')))
96 if (!pa_startswith(e
, "/card"))
102 static void verify_access(struct userdata
*u
, struct device
*d
) {
109 cd
= pa_sprintf_malloc("%s/snd/controlC%s", udev_get_dev_path(u
->udev
), path_get_card_id(d
->path
));
110 d
->accessible
= access(cd
, R_OK
|W_OK
) >= 0;
112 pa_log_info("%s is accessible: %s", cd
, pa_yes_no(d
->accessible
));
115 if (d
->module
== PA_INVALID_INDEX
) {
117 /* If we not loaded, try to load */
122 pa_log_debug("Loading module-alsa-card with arguments '%s'", d
->args
);
123 m
= pa_module_load(u
->core
, "module-alsa-card", d
->args
);
126 d
->module
= m
->index
;
127 pa_log_info("Card %s (%s) module loaded.", d
->path
, d
->card_name
);
129 pa_log_info("Card %s (%s) failed to load module.", d
->path
, d
->card_name
);
134 /* If we are already loaded update suspend status with
135 * accessible boolean */
137 if ((card
= pa_namereg_get(u
->core
, d
->card_name
, PA_NAMEREG_CARD
)))
138 pa_card_suspend(card
, !d
->accessible
, PA_SUSPEND_SESSION
);
142 static void card_changed(struct userdata
*u
, struct udev_device
*dev
) {
151 /* Maybe /dev/snd is now available? */
154 path
= udev_device_get_devpath(dev
);
156 if ((d
= pa_hashmap_get(u
->devices
, path
))) {
161 d
= pa_xnew0(struct device
, 1);
162 d
->path
= pa_xstrdup(path
);
163 d
->accessible
= TRUE
;
164 d
->module
= PA_INVALID_INDEX
;
166 if (!(t
= udev_device_get_property_value(dev
, "PULSE_NAME")))
167 if (!(t
= udev_device_get_property_value(dev
, "ID_ID")))
168 if (!(t
= udev_device_get_property_value(dev
, "ID_PATH")))
169 t
= path_get_card_id(path
);
171 n
= pa_namereg_make_valid_name(t
);
172 d
->card_name
= pa_sprintf_malloc("alsa_card.%s", n
);
173 d
->args
= pa_sprintf_malloc("device_id=\"%s\" "
178 "card_properties=\"module-udev-detect.discovered=1\"",
179 path_get_card_id(path
),
182 pa_yes_no(u
->use_tsched
),
183 pa_yes_no(u
->ignore_dB
));
186 pa_hashmap_put(u
->devices
, d
->path
, d
);
191 static void remove_card(struct userdata
*u
, struct udev_device
*dev
) {
197 if (!(d
= pa_hashmap_remove(u
->devices
, udev_device_get_devpath(dev
))))
200 pa_log_info("Card %s removed.", d
->path
);
202 if (d
->module
!= PA_INVALID_INDEX
)
203 pa_module_unload_request_by_index(u
->core
, d
->module
, TRUE
);
208 static void process_device(struct userdata
*u
, struct udev_device
*dev
) {
209 const char *action
, *ff
;
214 if (udev_device_get_property_value(dev
, "PULSE_IGNORE")) {
215 pa_log_debug("Ignoring %s, because marked so.", udev_device_get_devpath(dev
));
219 if ((ff
= udev_device_get_property_value(dev
, "SOUND_FORM_FACTOR")) &&
220 pa_streq(ff
, "modem")) {
221 pa_log_debug("Ignoring %s, because it is a modem.", udev_device_get_devpath(dev
));
225 action
= udev_device_get_action(dev
);
227 if (action
&& pa_streq(action
, "remove"))
229 else if ((!action
|| pa_streq(action
, "change")) &&
230 udev_device_get_property_value(dev
, "SOUND_INITIALIZED"))
231 card_changed(u
, dev
);
233 /* For an explanation why we don't look for 'add' events here
234 * have a look into /lib/udev/rules.d/78-sound-card.rules! */
237 static void process_path(struct userdata
*u
, const char *path
) {
238 struct udev_device
*dev
;
240 if (!path_get_card_id(path
))
243 if (!(dev
= udev_device_new_from_syspath(u
->udev
, path
))) {
244 pa_log("Failed to get udev device object from udev.");
248 process_device(u
, dev
);
249 udev_device_unref(dev
);
252 static void monitor_cb(
256 pa_io_event_flags_t events
,
259 struct userdata
*u
= userdata
;
260 struct udev_device
*dev
;
264 if (!(dev
= udev_monitor_receive_device(u
->monitor
))) {
265 pa_log("Failed to get udev device object from monitor.");
269 if (!path_get_card_id(udev_device_get_devpath(dev
)))
272 process_device(u
, dev
);
273 udev_device_unref(dev
);
277 a
->io_free(u
->udev_io
);
281 static pa_bool_t
pcm_node_belongs_to_device(
288 cd
= pa_sprintf_malloc("pcmC%sD", path_get_card_id(d
->path
));
289 b
= pa_startswith(node
, cd
);
295 static pa_bool_t
control_node_belongs_to_device(
302 cd
= pa_sprintf_malloc("controlC%s", path_get_card_id(d
->path
));
303 b
= pa_streq(node
, cd
);
309 static void inotify_cb(
313 pa_io_event_flags_t events
,
317 struct inotify_event e
;
320 struct userdata
*u
= userdata
;
322 pa_bool_t deleted
= FALSE
;
328 struct inotify_event
*event
;
331 if ((r
= pa_read(fd
, &buf
, sizeof(buf
), &type
)) <= 0) {
333 if (r
< 0 && errno
== EAGAIN
)
336 pa_log("read() from inotify failed: %s", r
< 0 ? pa_cstrerror(errno
) : "EOF");
344 if ((size_t) r
< sizeof(struct inotify_event
)) {
345 pa_log("read() too short.");
349 len
= sizeof(struct inotify_event
) + event
->len
;
351 if ((size_t) r
< len
) {
352 pa_log("Payload missing.");
356 /* From udev we get the guarantee that the control
357 * device's ACL is changed last. To avoid races when ACLs
358 * are changed we hence watch only the control device */
359 if (((event
->mask
& IN_ATTRIB
) && pa_startswith(event
->name
, "controlC")))
360 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
361 if (control_node_belongs_to_device(d
, event
->name
))
362 d
->need_verify
= TRUE
;
364 /* ALSA doesn't really give us any guarantee on the closing
365 * order, so let's simply hope */
366 if (((event
->mask
& IN_CLOSE_WRITE
) && pa_startswith(event
->name
, "pcmC")))
367 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
368 if (pcm_node_belongs_to_device(d
, event
->name
))
369 d
->need_verify
= TRUE
;
371 /* /dev/snd/ might have been removed */
372 if ((event
->mask
& (IN_DELETE_SELF
|IN_MOVE_SELF
)))
375 event
= (struct inotify_event
*) ((uint8_t*) event
+ len
);
380 PA_HASHMAP_FOREACH(d
, u
->devices
, state
)
381 if (d
->need_verify
) {
382 d
->need_verify
= FALSE
;
391 a
->io_free(u
->inotify_io
);
392 u
->inotify_io
= NULL
;
395 if (u
->inotify_fd
>= 0) {
396 pa_close(u
->inotify_fd
);
401 static int setup_inotify(struct userdata
*u
) {
405 if (u
->inotify_fd
>= 0)
408 if ((u
->inotify_fd
= inotify_init1(IN_CLOEXEC
|IN_NONBLOCK
)) < 0) {
409 pa_log("inotify_init1() failed: %s", pa_cstrerror(errno
));
413 dev_snd
= pa_sprintf_malloc("%s/snd", udev_get_dev_path(u
->udev
));
414 r
= inotify_add_watch(u
->inotify_fd
, dev_snd
, IN_ATTRIB
|IN_CLOSE_WRITE
|IN_DELETE_SELF
|IN_MOVE_SELF
);
418 int saved_errno
= errno
;
420 pa_close(u
->inotify_fd
);
423 if (saved_errno
== ENOENT
) {
424 pa_log_debug("/dev/snd/ is apparently not existing yet, retrying to create inotify watch later.");
428 if (saved_errno
== ENOSPC
) {
429 pa_log("You apparently ran out of inotify watches, probably because Tracker/Beagle took them all away. "
430 "I wished people would do their homework first and fix inotify before using it for watching whole "
431 "directory trees which is something the current inotify is certainly not useful for. "
432 "Please make sure to drop the Tracker/Beagle guys a line complaining about their broken use of inotify.");
436 pa_log("inotify_add_watch() failed: %s", pa_cstrerror(saved_errno
));
440 pa_assert_se(u
->inotify_io
= u
->core
->mainloop
->io_new(u
->core
->mainloop
, u
->inotify_fd
, PA_IO_EVENT_INPUT
, inotify_cb
, u
));
445 int pa__init(pa_module
*m
) {
446 struct userdata
*u
= NULL
;
448 struct udev_enumerate
*enumerate
= NULL
;
449 struct udev_list_entry
*item
= NULL
, *first
= NULL
;
451 pa_bool_t use_tsched
= TRUE
, ignore_dB
= FALSE
;
455 if (!(ma
= pa_modargs_new(m
->argument
, valid_modargs
))) {
456 pa_log("Failed to parse module arguments");
460 m
->userdata
= u
= pa_xnew0(struct userdata
, 1);
462 u
->devices
= pa_hashmap_new(pa_idxset_string_hash_func
, pa_idxset_string_compare_func
);
465 if (pa_modargs_get_value_boolean(ma
, "tsched", &use_tsched
) < 0) {
466 pa_log("Failed to parse tsched= argument.");
469 u
->use_tsched
= use_tsched
;
471 if (pa_modargs_get_value_boolean(ma
, "ignore_dB", &ignore_dB
) < 0) {
472 pa_log("Failed to parse ignore_dB= argument.");
475 u
->ignore_dB
= ignore_dB
;
477 if (!(u
->udev
= udev_new())) {
478 pa_log("Failed to initialize udev library.");
482 if (setup_inotify(u
) < 0)
485 if (!(u
->monitor
= udev_monitor_new_from_netlink(u
->udev
, "udev"))) {
486 pa_log("Failed to initialize monitor.");
491 if (udev_monitor_enable_receiving(u
->monitor
) < 0) {
492 pa_log("Failed to enable monitor: %s", pa_cstrerror(errno
));
494 pa_log_info("Most likely your kernel is simply too old and "
495 "allows only priviliged processes to listen to device events. "
496 "Please upgrade your kernel to at least 2.6.30.");
500 if ((fd
= udev_monitor_get_fd(u
->monitor
)) < 0) {
501 pa_log("Failed to get udev monitor fd.");
505 pa_assert_se(u
->udev_io
= u
->core
->mainloop
->io_new(u
->core
->mainloop
, fd
, PA_IO_EVENT_INPUT
, monitor_cb
, u
));
507 if (!(enumerate
= udev_enumerate_new(u
->udev
))) {
508 pa_log("Failed to initialize udev enumerator.");
512 if (udev_enumerate_add_match_subsystem(enumerate
, "sound") < 0) {
513 pa_log("Failed to match to subsystem.");
517 if (udev_enumerate_scan_devices(enumerate
) < 0) {
518 pa_log("Failed to scan for devices.");
522 first
= udev_enumerate_get_list_entry(enumerate
);
523 udev_list_entry_foreach(item
, first
)
524 process_path(u
, udev_list_entry_get_name(item
));
526 udev_enumerate_unref(enumerate
);
528 pa_log_info("Found %u cards.", pa_hashmap_size(u
->devices
));
537 udev_enumerate_unref(enumerate
);
547 void pa__done(pa_module
*m
) {
552 if (!(u
= m
->userdata
))
556 m
->core
->mainloop
->io_free(u
->udev_io
);
559 udev_monitor_unref(u
->monitor
);
565 m
->core
->mainloop
->io_free(u
->inotify_io
);
567 if (u
->inotify_fd
>= 0)
568 pa_close(u
->inotify_fd
);
573 while ((d
= pa_hashmap_steal_first(u
->devices
)))
576 pa_hashmap_free(u
->devices
, NULL
, NULL
);