Uh oh!
There was an error while loading. Please reload this page.
Introduction to Topology2.0 - #3983
Closed
ranj063 wants to merge 12 commits into
Closed
Conversation
ranj063
requested review from
dbaluta, lbetlej, lgirdwood, marc-hb, mmaka1 and plbossart
as code ownersMarch 30, 2021 03:29
marc-hb
reviewed
Mar 30, 2021
Collaborator
There was a problem hiding this comment.
As mentioned on the chat, you can't have ${input}.conf == ${output}.conf, no build system will support that.
I suggest sof-cnl-nocodec_output.conf or something.
marc-hb
commented
Mar 31, 2021
Collaborator
About ----- This is a high level keyword extension on top of the existing ALSA conf topology format designed to: 1) Simplify the ALSA conf topology definitions by providing high level "classes" so topology designers need to write less config for common object definitions. 2) Allow simple reuse of objects. Define once and reuse (like M4) with the ability to alter objects configuration attributes from defaults. 3) Allow data type and value verification. This is not done today and frequently crops up in FW bug reports. Common Topology Classes ----------------------- Topology today has some common classes that are often reused throughout with slightly altered configurations. i.e. widgets (components), pipelines, dais and controls. This PR introduces the high level concept of reusable "class" like definition for a AIF_IN/AIF_OUT type object that can be used to create topology objects. Common Topology Attributes -------------------------- Topology defines a lot of attributes per object with different types and constraints. Today there is no easy way to validate type or constraints and this can lead to many hard to find problems in FW at runtime. A new keyword "DefineAttribute" has been added to define attribute type, size, min value, max value, enum_values. This then allows alsatplg to validate each topology object attribute. Topology Classes define the list of attributes that they use and whether the attribute is mandatory, can be overridden by parent users or is immutable. This also helps alsatplg emit the appropriate errors for attribute misuse. Common Topology Arguments ------------------------- Arguments are used to pass essential data needed for instantiating an object particularly needed for the object name. A new keyword "DefineArgument" has been added to define the arguments. The order in which the arguments are defined determines the name for the widget. For example, in the case of the host widget, the name would be constructed as "host.1.playback" where "1" is the pipeline_id argument value and "playback" is the direction argument value. Attribute Inheritance: ---------------------- One of the key features of Topology2.0 is howthe attribute values are propagated from a parent object to a child object. This is accomplished by adding attributes/arguments with the same name for a parent and an object. By doing so, when creating a child object, the value for the common attribute is populated from the parent. If the value is provided in the child object instance, then it overrides the value coming from the parent. ALSA Conf Parser ---------------- All the changes being proposed and discussed here must be 100% compliant with the ALSA conf parser. i.e. no syntax changes or changes to semantics for any existing keyword. It's intended that there will be NO changes to the ALSA conf parser (unless new keywords require this ?) and all topology building changes will be in the alsatplg compiler. Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Add the class definition for DAI widgets. A DAI widget
can be instantiated as follows:
Object.Widget.dai."playback" {
type SSP
index "1"
period_sink_count "2"
period_source_count "0"
widget_type "dai_in"
}
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add the definition for the buffer class. A buffer object
can be instantiated as follows:
Object.Widget.buffer."N" {
pipeline_id 1
index 0
size 384
caps "host"
}
where 'N' is a unique instance number for the buffer object within
the same alsaconf node.
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add the class definition for PGA widget. It can be
instantiated as follows:
Object.Widget.pga."N" {
pipeline_id 1
index 0
}
Where N is the unique instance number for pga widget in the same
alsaconf node.
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add the class definition for a mixer control.
A mixer control can be instantiated as follows:
Object.Control.mixer."0" {
Object.Base.channel."fr" {
shift 0
}
Object.Base.channel."fl" {}
Object.Base.tlv."vtlv_m64s2" {
Object.scale."0" {
mute 1
}
}
Object.ops."ctl" {
info "volsw"
get 256
put 256
}
}
Also add the other commonly used class definitions that
will be used to instantiate the mixer object such as,
channel, TLV, ops, scale etc.
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add the volume and switch mixer control objects for the PGA class. The mixers will be added to the PGA widget if the pga widget is instantiated with the volume_mixer_name and switch_mixer_name attributes set. Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Add a route class that will be used for creating DAPM routes
between widgets. A route can be between 2 widgets or between a
widget and pipeline endpoint as follows:
Object.Base.route."N" {
source "dai.SSP.1.dai.capture"
sink "buffer.0.1"
}
Object.Base.route."N" {
source "buffer.2.1"
sink "pga.2.0"
}
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add 2 pipeline classes for Volume playback and Volume Capture.
Each of these classes includes the widget objects, their connections
and define attributes for the pipeline.
A volume playback pipeline can be instanted as follows:
Object.Pipeline.pipeline-volume-playback."2" {
channels 2
channels_min 2
channels_max 2
rate 48000
rate_min 48000
rate_max 48000
format "s32le"
}
Every pipeline class is associated with a pipeline widget, so
add the class definition for the pipeline widget as well.
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add the definitions SSP DAI and the hw_config classes.
These are used for instantiating the DAI objects in the
top-level topology file as follows:
Object.Dai.SSP."0" {
index 0
direction "duplex"
stream_name "NoCodec-0"
id 0
default_hw_config 0
format "s24le"
quirks "lbm_mode"
sample_bits 24
Object.Base.hw_config."0" {
id 0
mclk_freq 24000000
bclk_freq 4800000
tdm_slot_width 25
}
#Add DAI widgets
Object.Widget.dai."playback" {
direction "playback"
period_source_count 2
period_sink_count 0
}
Object.Widget.dai."capture" {
direction "capture"
period_source_count 0
period_sink_count 2
}
}
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>Add class definitions for PCM, PCM Capabilities and FE DAI objects.
These can be instantiated as:
Object.PCM.pcm."N" {
name "Headset"
direction "capture"
Object.fe_dai."Port 0" {
id "0"
}
Object.PCM.pcm_caps."capture" {
capabilities "Port0 Capture"
formats "S32_LE,S24_LE,S16_LE"
rate_min 48000
rate_max 48000
channels_min 2
channels_max 2
periods_min 2
}
}
Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>These will be used to add the ABI to the topology manifest section. Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
Add a simple machine topology showing 2 pipelines, an SSP DAI and the connections between the DAI endpoints and the pipeline endpoints. Add the manifest and data objects for adding ABI to the generated tplg file. Also add support for building the topology2 conf files. Signed-off-by: Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
gkbldcig
commented
May 10, 2021
Collaborator
Can one of the admins verify this patch? |
lgirdwood
commented
May 24, 2021
Member
For v1.9 - a reminder to merge after ALSA changes merged. |
marc-hb
commented
Jun 7, 2021
Collaborator
This PR should land the new Here's a proposition to implement a gradual transition for topology v1 to v2 once this PR is merged.
git churn is minimized. |
lgirdwood
commented
Jun 8, 2021
Member
@marc-hb I assume you will do an update to |
marc-hb
commented
Jun 8, 2021
Collaborator
No I was just answering an off-line question, sorry for the confusion. |
ranj063
commented
Jun 12, 2021
CollaboratorAuthor
closing this for now. Will post a new PR with smaller commits |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Alsa-lib changes: https://github.com/ranj063/alsa-lib/tree/topic/topology2-prep-wip
Alsa-utils changes:https://github.com/ranj063/alsa-utils/commits/topic/topology2.0