Skip to content
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.

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

Document (overlapping) codenames for toolchains, platforms, Kconfigurations, signing schemes, etc. #3491

Open
marc-hb opened this issue Oct 3, 2020 · 5 comments
Assignees
Labels
enhancement New feature or request P1 Blocker bugs or important features

Comments

@marc-hb
Copy link
Collaborator

marc-hb commented Oct 3, 2020

What do "TGL" or "CHT" mean? Are they Intel SoCs, PCH codenames, Kconfigurations, toolchain names, signing schemes? Probably a bit of everything depending on the context, no one knows for sure. No one except @jajanusz , who agreed in #3451 (comment) that some documentation is really needed. Quoting myself from there:

I can think of two places: either sof-docs or the top of src/arch/extensa/CMakeLists.txt but maybe there is a better place.

@marc-hb marc-hb added the enhancement New feature or request label Oct 3, 2020
@marc-hb marc-hb added the P2 Critical bugs or normal features label Oct 3, 2020
@lgirdwood
Copy link
Member

@marc-hb there is a platform description table in sof-docs - this info could be added in new columns. They are product names but also used for fw and toolchain config.

@marc-hb
Copy link
Collaborator Author

marc-hb commented Oct 5, 2020

They are product names but also used for fw and toolchain config.

These "accidental" 1:1:1 mappings seem pretty bad. Because they "accidentally" work until they don't:
#3451 (comment)

Short of renaming everything to tgl-toolchain, tgl-kconfig, etc., some documentation would really help mitigate.

@marc-hb marc-hb added P1 Blocker bugs or important features and removed P2 Critical bugs or normal features labels Oct 5, 2020
@marc-hb
Copy link
Collaborator Author

marc-hb commented Oct 13, 2020

marc-hb added a commit to marc-hb/sof that referenced this issue Jan 22, 2021
As reported in thesofproject#3491, there is confusion between platform names, CPU
names, PCH names, toolchain names, signing schemes and what not. For
instance in "build_apl_gcc/sof-apl.ri", the first "apl" matches the name
of a defconfig file while the second "apl" matches the name of a signing
scheme.

When building out-of-source, there is no reason to vary the filenames of
the output depending on the build configuration, changing the name of
the build directory is enough. This simplifies automation logic
including the next commit that adds a new install/GNUmakefile.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
marc-hb added a commit to marc-hb/sof that referenced this issue Feb 13, 2021
As reported in thesofproject#3491, there is confusion between platform names, CPU
names, PCH names, toolchain names, signing schemes and what not. For
instance in "build_apl_gcc/sof-apl.ri", the first "apl" matches the name
of a defconfig file while the second "apl" matches the name of a signing
scheme.

When building out-of-source, there is no reason to vary the filenames of
the output depending on the build configuration, changing the name of
the build directory is enough. This simplifies automation logic
including the next commit that adds a new install/GNUmakefile.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
lgirdwood pushed a commit that referenced this issue Feb 16, 2021
As reported in #3491, there is confusion between platform names, CPU
names, PCH names, toolchain names, signing schemes and what not. For
instance in "build_apl_gcc/sof-apl.ri", the first "apl" matches the name
of a defconfig file while the second "apl" matches the name of a signing
scheme.

When building out-of-source, there is no reason to vary the filenames of
the output depending on the build configuration, changing the name of
the build directory is enough. This simplifies automation logic
including the next commit that adds a new install/GNUmakefile.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
marc-hb added a commit to marc-hb/sof that referenced this issue Mar 4, 2021
As reported in thesofproject#3491, there is confusion between platform names, CPU
names, PCH names, toolchain names, signing schemes and what not. For
instance in "build_apl_gcc/sof-apl.ri", the first "apl" matches the name
of a defconfig file while the second "apl" matches the name of a signing
scheme.

When building out-of-source, there is no reason to vary the filenames of
the output depending on the build configuration, changing the name of
the build directory is enough. This simplifies automation logic
including the next commit that adds a new install/GNUmakefile.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
(cherry picked from commit 0e60ec8)
marc-hb added a commit to marc-hb/sof that referenced this issue Mar 11, 2021
As reported in thesofproject#3491, there is confusion between platform names, CPU
names, PCH names, toolchain names, signing schemes and what not. For
instance in "build_apl_gcc/sof-apl.ri", the first "apl" matches the name
of a defconfig file while the second "apl" matches the name of a signing
scheme.

When building out-of-source, there is no reason to vary the filenames of
the output depending on the build configuration, changing the name of
the build directory is enough. This simplifies automation logic
including the next commit that adds a new install/GNUmakefile.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
(cherry picked from commit 0e60ec8)
lgirdwood pushed a commit that referenced this issue Mar 18, 2021
As reported in #3491, there is confusion between platform names, CPU
names, PCH names, toolchain names, signing schemes and what not. For
instance in "build_apl_gcc/sof-apl.ri", the first "apl" matches the name
of a defconfig file while the second "apl" matches the name of a signing
scheme.

When building out-of-source, there is no reason to vary the filenames of
the output depending on the build configuration, changing the name of
the build directory is enough. This simplifies automation logic
including the next commit that adds a new install/GNUmakefile.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
(cherry picked from commit 0e60ec8)
marc-hb added a commit to marc-hb/sof that referenced this issue Sep 27, 2021
ADL and ADL-S binaries share FW build configuration with TGL and TGL-H.

See also issue thesofproject#3491 and commit 15e03fd ("config: intel: use PCH
name for tigerlake") and the corresponding review in PR thesofproject#3451.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
lgirdwood pushed a commit that referenced this issue Sep 29, 2021
ADL and ADL-S binaries share FW build configuration with TGL and TGL-H.

See also issue #3491 and commit 15e03fd ("config: intel: use PCH
name for tigerlake") and the corresponding review in PR #3451.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
marc-hb added a commit to marc-hb/sof that referenced this issue Oct 4, 2021
ADL and ADL-S binaries share FW build configuration with TGL and TGL-H.

See also issue thesofproject#3491 and commit 15e03fd ("config: intel: use PCH
name for tigerlake") and the corresponding review in PR thesofproject#3451.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
(cherry picked from commit 5a7a135)
lgirdwood pushed a commit that referenced this issue Oct 5, 2021
ADL and ADL-S binaries share FW build configuration with TGL and TGL-H.

See also issue #3491 and commit 15e03fd ("config: intel: use PCH
name for tigerlake") and the corresponding review in PR #3451.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
(cherry picked from commit 5a7a135)
@greg-intel
Copy link
Contributor

These links helped me a little:
ChromeOS Lead Vehicle Programs and Details (Updated July 2021)
ChromeOS Platform Decoder (Updated December 2021)

@lgirdwood
Copy link
Member

@greg-intel feel free to add links to these in sof-docs if not already stated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P1 Blocker bugs or important features
Projects
None yet
Development

No branches or pull requests

4 participants