• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1==========
2 alsatplg
3==========
4
5----------------------
6ALSA Topology Compiler
7----------------------
8
9:Author: Jaroslav Kysela <perex@perex.cz>
10:Date:   2018-10-09
11:Copyright: GPLv2+
12:Manual section: 1
13:Manual group: General Commands Manual
14
15SYNOPSIS
16========
17
18*alsatplg* <options> [command]
19
20DESCRIPTION
21===========
22
23alsatplg (ALSA Topology compiler) is a program to compile topology
24configuration file to the binary file for the kernel drivers.
25
26Current audio drivers typically hard code topology information
27in the driver sources: This tightly couples the audio driver
28to the development board making it time consuming to modify
29a driver to work on a different devices. The driver is also
30tightly coupled to the DSP firmware version meaning extra care
31is needed to keep the driver and firmware version in sync.
32New firmware features also mean driver updates.
33
34The ALSA topology project removes the need for re-writing or
35porting audio drivers to different devices or different firmwares:
36Drivers have no hard coded topology data meaning a single driver
37can be used on different devices by updating the topology data
38from the file system. Firmware updates can be pushed without
39having to update the drivers. The new firmware just needs
40to include an updated topology file describing the update.
41
42OPTIONS
43=======
44
45Available options:
46
47  **-h**, **--help**
48    this help
49
50  **-V**, **--version**
51    show the utility version and versions of used libraries
52
53  **-c**, **--compile** `FILE`
54    source configuration file for the compilation
55
56  **-d**, **--decode** `FILE`
57    source binary topology file for the decode
58
59  **-n**, **--normalize** `FILE`
60    parse and save the configuration file in the normalized format
61
62  **-u**, **--dump** `FILE`
63    parse and save the configuration file in the specified format
64
65  **-o**, **--output** `FILE`
66    output file
67
68  **-v**, **--verbose** `LEVEL`
69    set verbose level
70
71  **-s**, **--sort**
72    sort the configuration identifiers (set for normalization)
73
74  **-x**, **--nocheck**
75    save the configuration without additional integrity check
76
77  **-z**, **--dapm-nosort**
78    do not sort DAPM graph items (like in version 1.2.1-)
79
80
81FILES
82=====
83
84The master topology files for each supported sound card are in
85``/usr/share/alsa/topology``.
86
87For example, the master use case file for the `broadwell` card is in
88``/usr/share/alsa/topology/broadwell/broadwell.conf``, this file
89describes the audio hardware for the driver.
90
91For more details on the syntax of UCM files, see the alsa-lib source code:
92http://git.alsa-project.org/?p=alsa-lib.git;a=blob;f=src/topology/parser.c
93
94SEE ALSO
95========
96
97* Topology Interface: http://www.alsa-project.org/alsa-doc/alsa-lib/group__topology.html
98
99BUGS
100====
101
102None known.
103