OrgACRN
/
sof
mirror of https://github.com/thesofproject/sof.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

topology2: doc: mixer.conf: Doxygenify and improve the existing comments 

Improve and convert comments to doxygen documentation.

Signed-off-by: Jyri Sarha <jyri.sarha@linux.intel.com>
This commit is contained in:
Jyri Sarha 2023-05-11 17:52:27 +03:00 committed by Liam Girdwood
parent 37ac9fcc6a
commit 13cf2a2752
1 changed files with 38 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
tools/topology/topology2/include/controls/mixer.conf
View File

@ -1,41 +1,45 @@
# ## \struct mixer
# Mixer kcontrol class. All attributes defined herein are namespaced ## \brief Topology Mixer class
# by alsatplg to "Object.Control.mixer.N.attribute_name" ##
# ## All attributes defined herein are namespaced
# Usage: this component can be used by instantiating it in the parent object. i.e. ## by alsatplg to "Object.Control.mixer.N.attribute_name"
# ##
# Object.Control.mixer."N" { ## Usage: this component can be used by instantiating it in the parent object. i.e.
# index 1 ##
# name "1 Master Playback Volume" ## Object.Control.mixer."N" {
# mas 32 ## index 1
# Object.Base.channel.1 { ## name "1 Master Playback Volume"
# name "fl" ## max 32
# shift 0 ## Object.Base.channel.1 {
# reg 0 ## name "fl"
# } ## shift 0
# Object.Base.channel.2 { ## reg 0
# name "fr" ## }
# shift 1 ## Object.Base.channel.2 {
# reg 1 ## name "fr"
# } ## shift 1
# Object.Base.ops."ctl" { ## reg 1
# info "volsw" ## }
# get "258" ## Object.Base.ops."ctl" {
# put "258" ## info "volsw"
# } ## get "258"
# } ## put "258"
# ## }
# Where N is the unique instance number for the buffer object within the same alsaconf node. ## }
# The mixer control object should also include the ops, channels and tlv objects in the object ##
# instance ## The linked object instaces are \link channel \endlink and \link ops \endlink .
##
## Where N is the unique instance number for the buffer object within the same alsaconf node.
## The mixer control object should also include the ops, channels and tlv objects in the object
## instance
<include/controls/common.conf> <include/controls/common.conf>
Class.Control."mixer" { Class.Control."mixer" {
# ##
# Pipeline ID for the mixer object ## @ Pipeline ID for the mixer object
# ##
DefineAttribute."index" {} DefineAttribute."index" {} ##< Automatically given unique index
# #
# Instance of mixer object in the same alsaconf node # Instance of mixer object in the same alsaconf node