ucm2/README.md

   1 Use Case Configuration files
   2 ----------------------------
   3
   4 Library directories:
   5
   6   platforms/
   7   codecs/
   8   dsps/
   9
  10 Those directories are not inspected for the list of available UCM
  11 configurations. They contain files included from other UCMs.
  12
  13 UCM master configuration path lookup is defined in the top level
  14 ucm.conf file. This file allows custom directory layout. The new
  15 ucm2 layout is based on the ALSA driver name with the kernel driver
  16 name as fallback. The virtual cards (no direct hw bound) lookups are
  17 placed to the separate conf.virt.d directory.
  18
  19 The lookup configuration:
  20
  21   https://git.alsa-project.org/?p=alsa-ucm-conf.git;a=blob;f=ucm2/ucm.conf
  22
  23 Example paths - new conf.d scheme:
  24
  25 - conf.d/USB-Audio/Dell-WD15-Dock.conf
  26 -- special configuration for the Dell docking station with USB soundcard
  27 - conf.virt.d/TwoCardsMix.conf
  28 -- virtual UCM from two soundcards
  29
  30 Example paths - no conf.d scheme (may be invalidated):
  31
  32 - USB-Audio/Dell-WD15-Dock.conf
  33 -- special configuration for the Dell docking station with USB soundcard
  34 - TwoCardsMix/TwoCardsMix.conf
  35 -- virtual UCM from two soundcards
  36
  37 Note: For the driver configurations, use always the ALSA driver name or
  38 the real kernel driver name - not the ucm card name configuration paths!
  39
  40 The kernel driver name is obtained using sysfs like (last
  41 part of the path is used from the symlink):
  42
  43 ````
  44   /sys/class/sound/card0/device/driver
  45 ````
  46
  47 The ALSA driver name can be obtained using procfs like:
  48
  49 ````
  50   cat /proc/asound/cards
  51   1 [NVidia         ]: HDA-Intel - HDA NVidia
  52                        HDA NVidia at 0xb5080000 irq 17
  53
  54   driver name: HDA-Intel
  55   card short name: HDA NVidia
  56   card long name: HDA NVidia at 0xb5080000 irq 17
  57 ````
  58
  59 Syntax, value names
  60 -------------------
  61
  62 https://git.alsa-project.org/?p=alsa-lib.git;a=blob;f=include/use-case.h