Firmware - Revision history

Perex at 17:42, 9 February 2021

2021-02-09T17:42:37Z

Lrg at 14:48, 6 December 2017

2017-12-06T14:48:01Z

← Older revision		Revision as of 14:48, 6 December 2017
Line 111:		Line 111:
	cd ..		cd ..
	git clone git://git.kernel.org/pub/scm/linux/kernel/git/lrg/asoc.git		git clone git://git.kernel.org/pub/scm/linux/kernel/git/lrg/asoc.git
	git checkout -b sof origin/topic/~~reef~~-v4.8		git checkout -b sof origin/topic/sof-v4.15 (or newer version)

	The following configuration options should be set for Minnowboard Max or Asus T100 (prior to v4.15) :-		The following configuration options should be set for Minnowboard Max or Asus T100 (prior to v4.15) :-

Lrg at 14:46, 6 December 2017

2017-12-06T14:46:05Z

← Older revision		Revision as of 14:46, 6 December 2017
Line 105:		Line 105:
	The SOF requires some driver updates that are not yet upstream and they can be found here :-		The SOF requires some driver updates that are not yet upstream and they can be found here :-

	git://git.kernel.org/pub/scm/linux/kernel/git/lrg/asoc.git #topic/~~reef~~-v4.8		git://git.kernel.org/pub/scm/linux/kernel/git/lrg/asoc.git #topic/sof-v4.15 (or newer versions)

	This repo can be added as a remote to your existing kernel branch or can be checkout out by :-		This repo can be added as a remote to your existing kernel branch or can be checkout out by :-

Lrg at 14:27, 6 December 2017

2017-12-06T14:27:58Z

@@ Line 113: / Line 113: @@
   git checkout -b sof origin/topic/reef-v4.8
-The following configuration options should be set for Minnowboard Max or Asus T100 :-
+The following configuration options should be set for Minnowboard Max or Asus T100 (prior to v4.15) :-
   CONFIG_SND_SOC_INTEL_SST=m
@@ Line 126: / Line 126: @@
   CONFIG_SND_SOC_INTEL_BYT_RT5640_MACH=m
   CONFIG_SND_SOC_INTEL_BROADWELL_MACH=m
 Instructions for building the kernel can easily be found online or maybe specific for your distro.

Lrg at 13:44, 3 August 2017

2017-08-03T13:44:42Z

← Older revision		Revision as of 13:44, 3 August 2017
Line 10:		Line 10:


	The SDK comprises of five source components :-		The Sound Open Firmware SDK comprises of five source components :-

	'''1) Sound Open Firmware source code.''' The firmware is written in C with some architecture specific assembler and does not link to any external dependencies.		'''1) Sound Open Firmware source code.''' The firmware is written in C with some architecture specific assembler and does not link to any external dependencies.
Line 86:		Line 86:


	'''3. Get the ~~firmware~~ source code.'''		'''3. Get the Sound Open Firmware source code.'''

	The firmware source code is hosted using git on alsa-project.org		The firmware source code is hosted using git on alsa-project.org
Line 101:		Line 101:


	'''4. Get the Linux driver updates.'''		'''4. Get the Sound Open Firmware Linux driver updates.'''

	The SOF requires some driver updates that are not yet upstream and they can be found here :-		The SOF requires some driver updates that are not yet upstream and they can be found here :-
Line 144:		Line 144:
	Please do not install this version of Qemu as it will overwrite your distro version of Qemu.		Please do not install this version of Qemu as it will overwrite your distro version of Qemu.

	== '''Running ~~the~~ Firmware''' ==		== '''Running Sound Open Firmware''' ==

	The firmware image files should be copied to the Linux firmware directory in order for them to be loaded by the ALSA/ASoC drivers. This is usually /lib/firmware but some distributions may use other locations. The Intel platforms use the Intel subdirectory, so firmware should be copied to /lib/firmware/intel for Intel platforms.		The firmware image files should be copied to the Linux firmware directory in order for them to be loaded by the ALSA/ASoC drivers. This is usually /lib/firmware but some distributions may use other locations. The Intel platforms use the Intel subdirectory, so firmware should be copied to /lib/firmware/intel for Intel platforms.
Line 152:		Line 152:
	If the firmware fails to boot then it can be made to dump boot tracing information to the host. Please see firmware debugging.		If the firmware fails to boot then it can be made to dump boot tracing information to the host. Please see firmware debugging.

	== '''Firmware Architecture''' ==		== '''Sound Open Firmware Architecture''' ==

	The diagram below shows the high level firmware architecture with the Baytrail platform integration. The firmware is split into four main sections :-		The diagram below shows the high level firmware architecture with the Baytrail platform integration. The firmware is split into four main sections :-
Line 168:		Line 168:
	The left hand side of the diagram shows the Linux kernel ASoC driver and the mailbox/doorbell mechanism for IPC between the host and DSP.		The left hand side of the diagram shows the Linux kernel ASoC driver and the mailbox/doorbell mechanism for IPC between the host and DSP.

	== '''Driver Architecture''' ==		== '''Sound Open Firmware Driver Architecture''' ==

	The ASoC driver architecture for Sound Open Firmware is shown in the diagram below. The driver architecture is also split into four layers, like a protocol stack, each with a different purpose.		The ASoC driver architecture for Sound Open Firmware is shown in the diagram below. The driver architecture is also split into four layers, like a protocol stack, each with a different purpose.
Line 188:		Line 188:
	It's intended that the PCM and IPC drivers will be reused without modification on every platform. The platform differentiation will occur via the topology data and firmware. There is also scope for differentiation via the machine driver and platform driver. i.e. ACPI or Device Tree could be used to specify HW configuration.		It's intended that the PCM and IPC drivers will be reused without modification on every platform. The platform differentiation will occur via the topology data and firmware. There is also scope for differentiation via the machine driver and platform driver. i.e. ACPI or Device Tree could be used to specify HW configuration.

	== '''Debugging Firmware''' ==		== '''Debugging Sound Open Firmware''' ==

	Most small DSP devices that run firmware have limited debug facilities compared to debugging programs on a PC. i.e. there are usually no UARTs, network, GUI or even GPIOs/LEDs to use as a debugging aid when things go wrong. DSP development can sometimes require custom hardware debuggers (e.g via JTAG) or proprietary DSP emulators. Sound Open Firmware provides several free methods to develop and debug DSP firmware.		Most small DSP devices that run firmware have limited debug facilities compared to debugging programs on a PC. i.e. there are usually no UARTs, network, GUI or even GPIOs/LEDs to use as a debugging aid when things go wrong. DSP development can sometimes require custom hardware debuggers (e.g via JTAG) or proprietary DSP emulators. Sound Open Firmware provides several free methods to develop and debug DSP firmware.

Keyon: add details the gdb debug for Qemu VM part, with this sequence we can set breakpoint also.

2016-10-25T13:41:36Z

add details the gdb debug for Qemu VM part, with this sequence we can set breakpoint also.

← Older revision		Revision as of 13:41, 25 October 2016
Line 383:		Line 383:
	Qemu makes debugging code simpler as both driver and firmware can be run side by side with full memory, IO and register introspection. The qemu command line has many commands to display useful information about the Linux kernel and firmware states. GDB can additionally be attached to the Linux kernel on VM#1 or DSP firmware on VM#0.		Qemu makes debugging code simpler as both driver and firmware can be run side by side with full memory, IO and register introspection. The qemu command line has many commands to display useful information about the Linux kernel and firmware states. GDB can additionally be attached to the Linux kernel on VM#1 or DSP firmware on VM#0.

	1) Start Qemu VM with a GDB option from below.		1) Start Qemu xtensa VM with a GDB option from below:

	2) Start GDB and point it to reef ELF binary		comment out the line in xtensa-host.sh:

			./xtensa-softmmu/qemu-system-xtensa -s -S -cpu $CPU -M $ADSP -nographic

			Start xtensa VM:

			./xtensa-host.sh byt

			2) Start Qemu X86 VM:

			./x86-host.sh byt

			3) Start GDB and point it to reef ELF binary

	xtensa-byt-elf-gdb reef/src/arch/xtensa/reef		xtensa-byt-elf-gdb reef/src/arch/xtensa/reef

	3) Connect gdb to remote Qemu target		4) Connect gdb to remote Qemu target

	(gdb) target remote localhost:1234		(gdb) target remote localhost:1234

	4) Target firmware can now be debugged with regular GDB commands. e.g. :-		5) Target firmware can now be debugged with regular GDB commands. e.g. :-

	Reading symbols from reef/src/arch/xtensa/reef...done.		Reading symbols from reef/src/arch/xtensa/reef...done.
Line 410:		Line 422:
	#1 0xff2c0f51 in do_task (argc=argc@entry=-4, argv=argv@entry=0xe0000000) at audio.c:44		#1 0xff2c0f51 in do_task (argc=argc@entry=-4, argv=argv@entry=0xe0000000) at audio.c:44
	#2 0xff2c0b30 in main (argc=-4, argv=0xe0000000) at init.c:51		#2 0xff2c0b30 in main (argc=-4, argv=0xe0000000) at init.c:51
	(gdb)		(gdb) c
			Continuing.
			(gdb) b ipc_cmd
			(gdb) c
			Continuing.

	== '''FAQ''' ==		== '''FAQ''' ==

Lrg: /* Installing the SDK */

2016-10-25T12:16:56Z

Installing the SDK

← Older revision		Revision as of 12:16, 25 October 2016
Line 29:		Line 29:
	The instructions install the firmware and SDK in the ~/sof-sdk directory, but this can be any directory of your choice.		The instructions install the firmware and SDK in the ~/sof-sdk directory, but this can be any directory of your choice.

	Please install the following dependencies required for the ~~SDk~~ if you dont already have them installed.		Please install the following dependencies required for the SDK if you dont already have them installed.

	apt-get install git autoconf libtool gperf bison flex libtool libtool-bin libncurses5-dev		apt-get install git autoconf libtool gperf bison flex libtool libtool-bin libncurses5-dev

Lrg: /* Installing the SDK */

2016-10-25T12:16:38Z

Installing the SDK

← Older revision		Revision as of 12:16, 25 October 2016
Line 28:		Line 28:

	The instructions install the firmware and SDK in the ~/sof-sdk directory, but this can be any directory of your choice.		The instructions install the firmware and SDK in the ~/sof-sdk directory, but this can be any directory of your choice.

			Please install the following dependencies required for the SDk if you dont already have them installed.

			apt-get install git autoconf libtool gperf bison flex libtool libtool-bin libncurses5-dev

	'''1. Install the firmware image tools.'''		'''1. Install the firmware image tools.'''

Lrg: /* Installing the SDK */

2016-10-19T13:39:40Z

Installing the SDK

← Older revision		Revision as of 13:39, 19 October 2016
Line 74:		Line 74:
	git clone https://github.com/jcmvbkbc/newlib-xtensa.git		git clone https://github.com/jcmvbkbc/newlib-xtensa.git
	cd newlib-xtensa.git		cd newlib-xtensa.git
			git checkout -b xtensa origin/xtensa
	./configure --target=xtensa-byt-elf --prefix=~/sof-sdk/xtensa-root		./configure --target=xtensa-byt-elf --prefix=~/sof-sdk/xtensa-root
	make		make

Lrg: /* Installing the SDK */

2016-10-18T16:29:33Z

Installing the SDK

← Older revision		Revision as of 16:29, 18 October 2016
Line 65:		Line 65:
	./ct-ng build		./ct-ng build

	This creates a cross compiler in the builds/xtensa-byt-elf directory but the compiler is missing some headers it needs to build binaries. Luckily these headers can be easily installed by ~~copying from~~ the Xtensa Newlib C library. :-		Now add the Xtensa cross compiler to your PATH.

			PATH=~/sof-sdk/ct-ng.git/builds/xtensa-byt-elf/bin:$PATH

			This creates a cross compiler in the builds/xtensa-byt-elf directory but the compiler is missing some headers it needs to build binaries. Luckily these headers can be easily installed by building the Xtensa Newlib C library. :-

	cd ..		cd ..
	git clone https://github.com/jcmvbkbc/newlib-xtensa.git		git clone https://github.com/jcmvbkbc/newlib-xtensa.git
	~~cp -ap~~ newlib-xtensa.git/~~newlib/libc/include~~ xtensa-byt/elf/		cd newlib-xtensa.git
			./configure --target=xtensa-byt-elf --prefix=~/sof-sdk/xtensa-root
	~~Finally add the Xtensa cross compiler to your PATH.~~		make
			make install
	~~PATH~~=~/sof-sdk~~/ct-ng.git/builds~~/xtensa-~~byt-elf/bin:$PATH~~


	Please note that the xtensa GCC compiler only generates instructions using the core xtensa ISA and does not vectorize or use media instructions when generating Xtensa binaries (i.e. no automatic SIMD or media instructions generated without hand coding assembler). Cadence does however provide a free download of their optimising compiler tool chain for the Baytrail target here (todo add link).		Please note that the xtensa GCC compiler only generates instructions using the core xtensa ISA and does not vectorize or use media instructions when generating Xtensa binaries (i.e. no automatic SIMD or media instructions generated without hand coding assembler). Cadence does however provide a free download of their optimising compiler tool chain for the Baytrail target here (todo add link).
Line 87:		Line 89:
	cd sof.git		cd sof.git
	./autogen.sh		./autogen.sh
	./configure --with-arch=xtensa --with-platform=baytrail --with-~~tool~~-dir=~/~~path/to~~/xtensa~~/gcc~~/xtensa-byt-elf --host=xtensa-byt-elf		./configure --with-arch=xtensa --with-platform=baytrail --with-root-dir=~/sof-sdk/xtensa-root/xtensa-byt-elf --host=xtensa-byt-elf
	make		make
	make bin		make bin