]> git.alsa-project.org Git - alsa-ucm-conf.git/commitdiff
update README files readme
authorJaroslav Kysela <perex@perex.cz>
Mon, 30 Mar 2020 14:51:45 +0000 (16:51 +0200)
committerJaroslav Kysela <perex@perex.cz>
Mon, 30 Mar 2020 14:53:24 +0000 (16:53 +0200)
- UCM validator
- UCM paths for ucm2/

Signed-off-by: Jaroslav Kysela <perex@perex.cz>
README.md
ucm2/README.md

index 574c93ca4189b916394ec051bff25b18be8bec9f..c5afd963a7aa600c5a7020e8f2f11886b4262a31 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,3 +2,9 @@
 ## ALSA Use Case Manager configuration
 
 ![Validate UCM configuration](https://github.com/alsa-project/alsa-ucm-conf/workflows/Validate%20UCM%20configuration/badge.svg?branch=master)
+
+The UCM configurations are automatically valited using the UCM validator
+available at https://github.com/alsa-project/alsa-tests/tree/master/python/ucm-validator .
+
+If you create a pull request for new hardware, please, add also the
+alsa-info.sh output to emulate this hardware in the UCM validator.
index 3aefdf7e5c029fc877c4ad99075b26905c35bdf1..abde49ea8164e532278bff59fc5bd653f8382031 100644 (file)
@@ -7,9 +7,37 @@ Library directories:
   codecs/
   dsps/
 
-Those directories are not inspected for the list of
-available UCM configurations. They contain files
-included from other UCMs.
+Those directories are not inspected for the list of available UCM
+configurations. They contain files included from other UCMs.
+
+UCM master configuration path lookup (by priority):
+
+- {ucm_card_name}/{long_card_name}.conf
+- {ucm_card_name}/{ucm_card_name}.conf
+- {driver_name}/{long_card_name}.conf
+- {driver_name}/{driver_name}.conf
+
+For example:
+
+-  USB-Audio/Dell-WD15-Dock.conf
+-- special configuration for the Dell docking station with USB soundcard
+-  TwoCardsMix/TwoCardsMix.conf
+-- virtual UCM from two soundcards
+
+Note: For the driver configurations, use always the real driver name
+not the ucm card name configuration paths!
+
+The driver name can be obtained using procfs like:
+
+````
+  cat /proc/asound/cards
+  1 [NVidia         ]: HDA-Intel - HDA NVidia
+                       HDA NVidia at 0xb5080000 irq 17
+
+  driver: HDA-Intel
+  card name: HDA NVidia
+  card long name: HDA NVidia at 0xb5080000 irq 17
+````
 
 Syntax, value names
 -------------------