ALSA topology - Revision history

Mengdonglin: /* Kernel */

2016-11-27T16:46:45Z

Kernel

← Older revision		Revision as of 16:46, 27 November 2016
Line 36:		Line 36:
	=== Kernel ===		=== Kernel ===
	The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.		The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.
	~~And~~ Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.
			==== ''How device drivers use topology'' ====
			Intel Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.

Mengdonglin: /* How to generate the topology binary file */

2016-11-27T16:45:42Z

How to generate the topology binary file

← Older revision		Revision as of 16:45, 27 November 2016
Line 30:		Line 30:
	==== ''How to generate the topology binary file ====		==== ''How to generate the topology binary file ====
	Users can define topology objects in a text configuration file. The syntax is based on alsaconf syntax, please see alsa-lib/include/alsa/topology.h		Users can define topology objects in a text configuration file. The syntax is based on alsaconf syntax, please see alsa-lib/include/alsa/topology.h
	Then users can use alsatplg, the topology tool in alsa-utils, to covert the topology text configuration file to the binary, via command "alsatplg -c <path-of-input-text-configuration-file> -o <path-of-output-binary-file>". Please see the alsatplg code in directory topology of alsa-utils.		Then users can use alsatplg, the topology tool in alsa-utils, to covert the topology text configuration file to the binary, via command "alsatplg -c <path-of-input-text-configuration-file> -o <path-of-output-binary-file>". Please see the alsatplg code in directory topology of alsa-utils, and Intel Broadwell and Skylake configurations in alsa-lib/src/conf/topology as examples of the text configuration file.

			Users can also write their own application and call topology library API to add objects and generate the binary file. Please see alsa-lib/include/alsa/topology.h for the API definition.

	=== Kernel ===		=== Kernel ===
	The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.		The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.
	And Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.		And Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.

Mengdonglin: /* User space */

2016-11-27T16:41:48Z

User space

← Older revision		Revision as of 16:41, 27 November 2016
Line 24:		Line 24:

	=== User space ===		=== User space ===
	The topology library is part of alsa-lib. It can ~~generate a binary file~~ that ~~describes~~ the ~~internal~~ topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. Users can define topology objects that describe the topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. These topology objects can be defined either in a text configuration file or added via C API. And the topology library will parse them and generate a binary file for kernel. Please see the source code in directory src/topology of alsa-lib.

	~~==== ''How to generate~~ topology info ~~in user space'' ====~~		The generated topology binary file consists of a manifest and a list of blocks. The manifest data provides overall info of the topology object types in the file, i.e. number of controls, widgets, routes, PCMs, physical DAI and physical DAI links. Each block consists of a blocker header and a specific type of topology objects. For the layout of file and topology object, please see the ABI file in alsa-lib include/sound/asoc.h and tlv.h
	~~TBD~~
	~~The~~ topology ~~tool~~ in ~~alsa-utils~~, ~~alsatplg~~, ~~can covert~~ a topology ~~text configuration~~ file ~~to the binary. Please~~ see the ~~source code~~ in ~~directory topology of~~ alsa-~~utils~~.

	~~The generated~~ topology binary file ~~consists of~~ a ~~manifest and a list of blocks~~. The ~~manifest data provides overall info of~~ the topology ~~object types~~ in the file, ~~i.e. number~~ of ~~controls, widgets, routes, PCMs, physical DAI and physical DAI links. Each block consists~~ of ~~a blocker header and a specific type of topology objects~~. ~~For the layout of file and topology object, please~~ see the ~~ABI file~~ in alsa-~~lib include/sound/asoc.h and tlv~~.h		==== ''How to generate the topology binary file ====
			Users can define topology objects in a text configuration file. The syntax is based on alsaconf syntax, please see alsa-lib/include/alsa/topology.h
			Then users can use alsatplg, the topology tool in alsa-utils, to covert the topology text configuration file to the binary, via command "alsatplg -c <path-of-input-text-configuration-file> -o <path-of-output-binary-file>". Please see the alsatplg code in directory topology of alsa-utils.

	=== Kernel ===		=== Kernel ===
	The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.		The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.
	And Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.		And Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.

Mengdonglin: /* User space */

2016-11-27T16:12:51Z

User space

← Older revision		Revision as of 16:12, 27 November 2016
Line 23:		Line 23:
	[[File:Topology.png]]		[[File:Topology.png]]

	=== ''User space'' ===		=== User space ===
	The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.

	==== How to generate topology info in user space ====		==== ''How to generate topology info in user space'' ====
	TBD		TBD
	The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.		The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.

Mengdonglin: /* User space */

2016-11-27T16:11:55Z

User space

← Older revision		Revision as of 16:11, 27 November 2016
Line 23:		Line 23:
	[[File:Topology.png]]		[[File:Topology.png]]

	=== '''User space''' ===		=== ''User space'' ===
	The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.

Mengdonglin: /* How device drivers use topology */

2016-11-27T16:11:34Z

How device drivers use topology

← Older revision		Revision as of 16:11, 27 November 2016
Line 35:		Line 35:
	The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.		The topology kernel driver provides API for device drivers to load the topology binary file from the user space, then it will parse the ABI objects in the file, create controls, widgets, routes, front end DAI and DAI links (PCMs) and configure existing physical DAI and DAI links. It will also let the device driver do platform specific initialization on these objects via topology ops registered by the device driver. Please see code of sound/soc/soc-topology.c in kernel.
	And Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.		And Skylake platform driver is an example how device drivers use topology, please see code of sound/soc/intel/skylake/skl-topology.c in kernel.

	~~== '''How device drivers use topology ''' ==~~
	~~TBD~~

Mengdonglin: /* User space */

2016-11-27T16:11:14Z

User space

← Older revision		Revision as of 16:11, 27 November 2016
Line 23:		Line 23:
	[[File:Topology.png]]		[[File:Topology.png]]

	=== User space ===		=== '''User space''' ===
	The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.

Mengdonglin: /* 'How to generate topology info in user space' */

2016-11-27T16:10:54Z

'How to generate topology info in user space'

← Older revision		Revision as of 16:10, 27 November 2016
Line 26:		Line 26:
	The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.

	==== 'How to generate topology info in user space' ====		==== How to generate topology info in user space ====
	TBD		TBD
	The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.		The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.

Mengdonglin: /* User space */

2016-11-27T16:10:29Z

User space

← Older revision		Revision as of 16:10, 27 November 2016
Line 26:		Line 26:
	The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.

	==== '''How to generate topology info in user space''' ====		==== 'How to generate topology info in user space' ====
	TBD		TBD
	The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.		The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.

Mengdonglin: /* User space */

2016-11-27T16:10:05Z

User space

← Older revision		Revision as of 16:10, 27 November 2016
Line 26:		Line 26:
	The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.		The topology library is part of alsa-lib. It can generate a binary file that describes the internal topology of a customer firmware, e.g. for an ADSP embedded in SOC or an off-SOC codec. Please see the source code in directory src/topology of alsa-lib.

			==== '''How to generate topology info in user space''' ====
			TBD
	The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.		The topology tool in alsa-utils, alsatplg, can covert a topology text configuration file to the binary. Please see the source code in directory topology of alsa-utils.