{"id":40627187,"url":"https://github.com/thesofproject/avs-topology-xml","last_synced_at":"2026-01-21T07:25:53.495Z","repository":{"id":96247336,"uuid":"547212758","full_name":"thesofproject/avs-topology-xml","owner":"thesofproject","description":"Configuration files for Intel AudioVoiceSpeech (AVS) driver","archived":false,"fork":false,"pushed_at":"2025-03-27T11:47:34.000Z","size":105,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-27T12:32:11.966Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Perl","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thesofproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-10-07T10:09:08.000Z","updated_at":"2025-03-27T11:47:37.000Z","dependencies_parsed_at":null,"dependency_job_id":"af8ede9e-0913-48f5-bda2-0550aee1f95c","html_url":"https://github.com/thesofproject/avs-topology-xml","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/thesofproject/avs-topology-xml","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesofproject%2Favs-topology-xml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesofproject%2Favs-topology-xml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesofproject%2Favs-topology-xml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesofproject%2Favs-topology-xml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thesofproject","download_url":"https://codeload.github.com/thesofproject/avs-topology-xml/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thesofproject%2Favs-topology-xml/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28629915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-21T04:47:28.174Z","status":"ssl_error","status_checked_at":"2026-01-21T04:47:22.943Z","response_time":86,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-21T07:25:52.790Z","updated_at":"2026-01-21T07:25:53.481Z","avatar_url":"https://github.com/thesofproject.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"Configuration files for Intel AudioVoiceSpeech (AVS) driver\n========================\n\n * [Overview](#overview)\n   * [DMIC](#dmic)\n   * [HDAudio](#hdaudio)\n   * [HDMI](#hdmi)\n   * [I2S](#i2s)\n * [Contributing](#contributing)\n   * [Commit title](#commit-title)\n     * [Scoping](#scoping)\n   * [Commit message](#commit-message)\n   * [Commit tags](#commit-tags)\n\n# Overview\n\nEach configuration file represents an audio stream topology i.e.: connections of AudioDSP pipelines\nand processing modules that provide rich user experience with the Intel AVS stack. The avs-driver is\npart of the Linux kernel sound subsystem,\n[sound/soc/intel/avs](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/sound/soc/intel/avs).\n\nRelated to [alsa-topology-conf](https://github.com/alsa-project/alsa-topology-conf) yet instead of\nUseCaseManagement (UCM) files, topologies found here are XML document files.\n\nAs the audio stack supports audio transfer over multiple interfaces, repository consists of\ndirectories representing one interface each.\n\nKernel sound drivers are not capable of consuming topologies in their XML format. In order to obtain\nkernel-friendly format, topology needs to be converted to UCM format first using\n[avstplg](https://github.com/thesofproject/avsdk/tree/main/avstplg) tool and then finally to binary\nusing alsatplg, which is available by default on any Linux distribution.\n\nFlow of conversion, from XML to bin:\n```\n\tXML  -\u003e  avstplg   -\u003e  UCM\n\tUCM  -\u003e  alsatplg  -\u003e  bin\n```\nResult binaries are to be placed under `/lib/firmware/intel/avs` so they can be loaded by the\nkernel.\\\n**Note:** the avs-driver loads only topologies for devices that have successfully enumerated during\nsystem boot and are listed in supported configurations list found in:\n[board_selection.c](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/sound/soc/intel/avs/board_selection.c)\nfile.\n\n## DMIC\n\nDigital Microphone support. Repository contains universal, multi-format topology that should work on\nall Intel platforms equipped with AudioDSP, starting from Skylake onward.\n\n## HDAudio\n\nHDAudio codec expose anywhere between one to three uni or bidirectional endpoints:\nAnalog/Digital/Alt Analog. The actual number of supported endpoints and their description is\nobtained during codec enumeration on the HDAudio bus.\n\nRepository contains simple, generic reference for single-endpoint variant which should work for any\nHDaudio configuration.\n\n## HDMI\n\nFollows the similar scheme as the [HDAudio](#hdaudio). The directory contains topology files\nsupporting Intel-devices only, that is HDAudio codecs that expose `0x8086` as their Vendor ID.\nAnother specific detail is that no capture streams are part of those topologies - all the HDMI\nendpoints are unidirectional.\n\nIn general, given the PlatformControllerHub (PCH) generation, a HDMI device falls into: three, five\nor nine -endpoint category. References for all of them are available.\n\n## I2S\n\nLeast generic out of all available. Often a specific configuration is used per codec device. See\n[sound/soc/intel/avs/boards](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/sound/soc/intel/avs/boards)\nto check whether given configuration is supported by the kernel driver.\n\n# Contributing\n\nWhile building a topology file requires some AudioDSP knowledge, especially in the driver \u003c-\u003e\nfirmware interaction area, all contributions are welcome. Project follows submission guidelines\nsimilar to those of high-profile projects, such as the Linux kernel.\n\n## Commit title\n\nCommit message title line length is limited to 72 characters.\n\n### Scoping\n\nScoping shall be used to indicate the context of introduced changes, through adding subdirectory tag\n('tag: ') at the beginning of commit's title. Leave the scope out only when submitting repo-wide\nchanges.\n\nThe scopes for subdirectories go as follows:\n```\ndmic/\t\tdmic\nhda/\t\thda\nhdmi/\t\thdmi\ni2s/\t\ti2s\n```\n\n## Commit message\n\nRegardless of type of change you want to submit, it must be described.\nPlease follow [Describe your changes](\nhttps://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes) guide\nfor the best practises of doing so. The guide is quite lengthy, the essence is captured below:\n\n*   State the motivation behind the change\n*   Be transparent, do not hide things\n*   Describe user impact if any\n*   Use imperative mood\n*   The lower level the problem is, the more detailed the description\n    should be.\n*   Ensure any links or references appended are actually working\n*   Keep the line width with 72 characters margin\n\n## Commit tags\n\n[Sign your work](https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin).\n\nOptionally, at the bottom of commit message tags (kind of keywords) can be appended. These tags\nserve informational purposes, further enhancing code documentation and enabling fixes propagation\nthrough automated tasks. Below are guides for a range of such tags:\n\nWhen to use [Acked-by:, Cc:, and Co-developed-by:](\nhttps://www.kernel.org/doc/html/latest/process/submitting-patches.html#when-to-use-acked-by-cc-and-co-developed-by)\\\nUsing [Reported-by:, Tested-by:, Reviewed-by:, Suggested-by: and Fixes:](\nhttps://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes)\\\nThe final paragraphs of [Describe your changes](\nhttps://www.kernel.org/doc/html/latest/process/submitting-patches.html#describe-your-changes) help\nsetup git config so appending correctly formatted **Fixes:** tag becomes trivial.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesofproject%2Favs-topology-xml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthesofproject%2Favs-topology-xml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthesofproject%2Favs-topology-xml/lists"}