Skip to content

topology2: Mod cfg ibs obs cpc addition#7348

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jsarha wants to merge 3 commits into from
Closed

topology2: Mod cfg ibs obs cpc addition #7348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2106e58
topology2: Add mod_cfgs class and num_mod_cfg attribute widget common
Mar 27, 2023
3b6ade5
topopogy2: include/components: Add common include file to all components
Apr 24, 2023
c3bd46e
topology2: Add placeholders for platform and module specific mod_cfgs
Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions tools/topology/topology2/include/common/mod_cfg.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
# Class definition for module configuration object
# mod_cfg objects can be instantiated as:
#
# Object.Base.mod_cfg."0" {
# ibs 384
# obs 384
# cpc 4600

@btian1btian1Nov 22, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we add comments here:
for ibs/obs, it is initialized as: 48 * 2 * 4 = 384, it is 48k LL with 2 channel 32 bit format.
for cpc, I am not sure how CPC figured out as instantiated value?

# }
#

Class.Base."mod_cfg" {

DefineAttribute."instance" {
}

# input buffer size

@btian1btian1Nov 22, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's give comments like:
ibs = (sample rate / (1000000/period)) * channels * valid_sample_width

DefineAttribute."ibs" {
# Token set reference name
token_ref "sof_tkn_mod_cfg.word"
}

# output buffer size
DefineAttribute."obs" {
# Token set reference name
token_ref "sof_tkn_mod_cfg.word"
}

# Cycles Per Chunk
DefineAttribute."cpc" {
# Token set reference name
token_ref "sof_tkn_mod_cfg.word"
}

attributes {
!constructor [
"instance"
]

#
# mod_cfg objects instantiated within the same alsaconf node
# must have unique instance attribute values
#
unique "instance"
}
}
9 changes: 9 additions & 0 deletions tools/topology/topology2/include/common/tokens.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -24,6 +24,7 @@ Object.Base.VendorToken {
output_pin_binding_name 414
num_input_audio_formats 415
num_output_audio_formats 416
num_mod_cfgs 417
}

"2" {
Expand DownExpand Up@@ -180,4 +181,12 @@ Object.Base.VendorToken {
node_type 1980
deep_buffer_dma_ms 1981
}

# ABI 4.0 onwards
"19" {
name "sof_tkn_mod_cfg"
ibs 1990
obs 1991
cpc 1992
}
}
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/asrc.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# }
#
# Where N is the unique instance number for the src widget within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."asrc" {
#
Expand All@@ -28,6 +29,12 @@ Class.Widget."asrc" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the asrc module

@ranj063ranj063Apr 26, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jsarha is there value in this commit just yet? Can we not add the files as and when needed?

@jsarhajsarhaApr 26, 2023•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure we can. Just drop the last commit. It is all about interpreting this request #7348 (comment) .

Whether "Can we have?" is interpreted as if we can in theory or if the files should actually be added in practice. If it means in theory, then consider the last commit as a proof of concept.

Then again, adding them here and now would make it more likely that platform and component specific mod_cfgs files will be added in uniform way, following the same naming scheme for all the components.

@kv2019ikv2019iApr 27, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lgirdwood Can you ack as this was an ask from you? I.e. to have the placeholders or not.

@btian1btian1Nov 22, 2023

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  1. I agree add on demand.
  2. if want to add in this patch, I would suggest there is a folder to cover all component instead of directly under platform/intel/mod_cfg/

IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_asrc.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_asrc.conf"
}

#
# ASRC widget UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/buffer.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
# }
#
# Where N is the unique instance number for the buffer object within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."buffer" {
#
Expand All@@ -27,6 +28,12 @@ Class.Widget."buffer" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the buffer module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_buffer.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_buffer.conf"
}

#
# Buffer component UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/copier.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
# }
#
# Where N is the unique instance number for the copier object within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."copier" {
#
Expand All@@ -31,6 +32,12 @@ Class.Widget."copier" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the copier module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_copier.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_copier.conf"
}

#
# Copier component UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/dai.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,6 +16,7 @@
# type dai_out
# }
#
<include/components/widget-common-inc.conf>

Class.Widget."dai" {
# Type of DAI
Expand DownExpand Up@@ -62,6 +63,12 @@ Class.Widget."dai" {
# include common widget attribute definitions
<include/components/widget-common.conf>

#include platform specific module configs for the dai module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_dai.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_dai.conf"
}

#
# Pipeline ID that the dai widget belongs to
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/eqfir.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@

#
# Where M is pipeline ID and N is a unique integer in the parent object.
<include/components/widget-common-inc.conf>

Class.Widget."eqfir" {
#
Expand All@@ -31,6 +32,12 @@ Class.Widget."eqfir" {
# Include common widget attributes definition
<include/components/widget-common.conf>

#include platform specific module configs for the eqfir module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_eqfir.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_eqfir.conf"
}

DefineAttribute.uuid {
# Token set reference name and type
token_ref "sof_tkn_comp.uuid"
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/eqiir.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@

#
# Where M is pipeline ID and N is a unique integer in the parent object.
<include/components/widget-common-inc.conf>

Class.Widget."eqiir" {
#
Expand All@@ -31,6 +32,12 @@ Class.Widget."eqiir" {
# Include common widget attributes definition
<include/components/widget-common.conf>

#include platform specific module configs for the eqiir module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_eqiir.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_eqiir.conf"
}

DefineAttribute.uuid {
# Token set reference name and type
token_ref "sof_tkn_comp.uuid"
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/gain.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@
# }
#
# Where N is the unique instance number for gain widget in the same alsaconf node.
<include/components/widget-common-inc.conf>

<include/controls/mixer.conf>

Expand All@@ -30,6 +31,12 @@ Class.Widget."gain" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the gain module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_gain.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_gain.conf"
}

#
# gain widget UUID
#
Expand Down
8 changes: 8 additions & 0 deletions tools/topology/topology2/include/components/host.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@
# type aif_out
# }

<include/components/widget-common-inc.conf>

#
# "host" class belongs to the "Widget" group of classes.
#
Expand DownExpand Up@@ -59,6 +61,12 @@ Class.Widget."host" {
#include common widget attributes
<include/components/widget-common.conf>

#include platform specific module configs for the host module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_host.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_host.conf"
}

DefineAttribute.uuid {
type "string"
# Token set reference name and type
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/kpb.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
# }
#
# Where N is the unique instance number for the kpb object within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."kpb" {
#
Expand All@@ -31,6 +32,12 @@ Class.Widget."kpb" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the kpb module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_kpb.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_kpb.conf"
}

#
# kpb component UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/micsel.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
# }
#
# Where N is the unique instance number for the micsel object within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."micsel" {
#
Expand All@@ -31,6 +32,12 @@ Class.Widget."micsel" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the micsel module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_micsel.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_micsel.conf"
}

#
# micsel component UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/mixin.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
# }
#
# Where N is the unique instance number for the mixin object within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."mixin" {
#
Expand DownExpand Up@@ -47,6 +48,12 @@ Class.Widget."mixin" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the mixin module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_mixin.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_mixin.conf"
}

#
# Copier component UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/mixout.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
# }
#
# Where N is the unique instance number for the mixout object within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."mixout" {
#
Expand DownExpand Up@@ -47,6 +48,12 @@ Class.Widget."mixout" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the mixout module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_mixout.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_mixout.conf"
}

#
# Copier component UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/muxdemux.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,6 +13,7 @@

#
# Where N is a unique integer in the parent object.
<include/components/widget-common-inc.conf>

Class.Widget."muxdemux" {
#
Expand All@@ -29,6 +30,12 @@ Class.Widget."muxdemux" {
#include common widget attribute definitions
<include/components/widget-common.conf>

#include platform specific module configs for the muxdemux module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_muxdemux.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_muxdemux.conf"
}

DefineAttribute.uuid {
type "string"
# Token set reference name and type
Expand Down
1 change: 1 addition & 0 deletions tools/topology/topology2/include/components/pipeline.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -12,6 +12,7 @@
# }
#
# Where N is the unique instance number for pipeline widget in the same alsaconf node.
<include/components/widget-common-inc.conf>

Define {
# If KCPS value for the pipeline is 0 then the driver does not send any
Expand Down
8 changes: 8 additions & 0 deletions tools/topology/topology2/include/components/smart_amp.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,8 @@

# set the default the SMART_AMP_UUID to be that of the test smart amp module.
# The top-level machine topology must override this definition to use a different module
<include/components/widget-common-inc.conf>

Define {
SMART_AMP_UUID "1e:96:7a:16:e4:8a:ea:11:89:f1:00:0c:29:ce:16:35"
}
Expand All@@ -28,6 +30,12 @@ Class.Widget."smart_amp" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the smart_amp module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_smart_amp.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_smart_amp.conf"
}

#
# smart_amp widget UUID
#
Expand Down
7 changes: 7 additions & 0 deletions tools/topology/topology2/include/components/src.conf
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,6 +11,7 @@
# }
#
# Where N is the unique instance number for the src widget within the same alsaconf node.
<include/components/widget-common-inc.conf>

Class.Widget."src" {
#
Expand All@@ -26,6 +27,12 @@ Class.Widget."src" {
#include common component definition
<include/components/widget-common.conf>

#include platform specific module configs for the src module
IncludeByKey.PLATFORM {
"mtl" "platform/intel/mod_cfg/mod_cfg_mtl_src.conf"
"tgl" "platform/intel/mod_cfg/mod_cfg_tgl_src.conf"
}

#
# SRC widget UUID
#
Expand Down
Loading