build directory
The build directory initially contains an example (default tuned) image which can be flashed onto
the Nebula platform. This is the image the customer would first flash onto their platform before
starting to do audio tuning.
When the final tuned image is built, the default tuned image is stored as *.sfs.orig. The new
tuned image is stored in the same directory.
This directory contains the following files:
*-DDDDDX.sfs
*-DDDDDX-padded.sfs
i2c_flash.exe
iflash.bin
This is the un-padded image to be flashed onto the Nebula platform. Once a tuned image is built,
the original *-DDDDDX.sfs file will be stored as *-DDDDDX.sfs.orig, and the new tuned image
will be stored as *-DDDDDX.sfs. (This copy of *-DDDDDX.sfs to *-DDDDDX.sfs.orig happens
only when there is no other *-DDDDDX.sfs.orig present. This is done to preserve the original
default build).
-DDDDDX-padded.sfs file
This is the padded image which can be flashed onto the Nebula platform. This is padded to fill the
entire flash area. The default flash size selected is 32 Mbit / 4MByte. This file is typically needed
when the SPI flash is programmed by the EEPROM programmer at the manufacturing site before
the device is placed on the PCB.
Once a tuned image is built, the original *-DDDDDX-padded.sfs file will be stored as *-DDDDDXpadded.sfs.orig, and the new tuned padded image will be stored as *-DDDDDX-padded.sfs.
(This copy of *-DDDDDX-padded.sfs to *-DDDDDX-padded.sfs.orig happens only when
there is no other *-DDDDDX-padded.sfs.orig present. This is done to preserve the original
default padded image).
7.1.3. i2c_flash.exe file
The i2c_flash.exe is the tool used for flashing the image onto the Nebula platform using I2C
connection. The flashing can be done by just double clicking on this executable from a Windows
PC. This tool will download the bootloader (iflash.bin) and the un-padded image from the same
directory as the i2c_flash.exe tool. One can also flash any sfs image by dropping that image on
top of the i2c_flash.exe tool.
Before downloading the bootloader and after downloading the firmware, the device needs to be
reset.
This tool when run from the Windows PC, resets the device before downloading the bootloader
and after downloading the firmware when using EVK/RDK board. Device reset is needed if using
any other board in these instances
iflash.bin file
The iflash.bin is the I2C bootloader which is downloaded by the i2c_flash.exe file to flash the
image to the Nebula platform.
7.2. documentation directory
The documentation directory contains the documentations.
7.3. fw directory
The fw directory contains the files needed to build the final image.
7.4. host_demo_code directory
The host_demo_code directory contains reference host code files. This code can be used as a
reference to generate the host code to flash the CAPE firmware onto Nebula platform and to select
the various modes from the host.
It contains the following VC++ solutions
7.4.1. demogenerichost_demo.sln
This VC++ solution contains the project to build the host demo code which:
(1) Change audio mode
(2) Get the current mode
(3) Get firmware version
7.4.2. demoi2c_flashi2c_flash.sln
This VC++ solution contains the project to build the host demo code to generate the I2C
programming application (i2c_flash.exe).
7.5. scripts directory
The scripts directory contains tuned TCL scripts. These scripts contain the tuning parameters for
the various modes. These files can be overwritten while saving the audio tuning by the audio tuning
GUI.
These script files need to be named in a specific format:
__.tcl
The is the one present for all of the other scripts in the scripts directory. It is an
alphanumeric sequence with no spaces. The is a 4 character alphanumeric code in uppercase with no spaces. We recommend this mode always begin with the character “Z”. The
is alphanumeric sequence which may contain underscores but not spaces.
e.g.: nbrdk_ZSH2_speech_recog_ssp_ref2ch_ASR_wide.tcl
Here nbrdk is the prefix, ZSH2 is the mode.
Besides the tuned scripts, there is also a _CONF_mode.tcl file, which contains the default
power-on mode of the device. This is generated when running build_fcp.bat. This file should not be
overwritten or change manually. Since, it is not a real “audio mode”, the CONF is not listed as a
mode in the audio tuning GUI.
7.6. tools directory
The tools directory contains the tools needed to build the tuned image. This directory also
contains the CAF Audio Tuning tool – caf_tuning.exe. It also contains the Golem file *.glm file
which is used by the audio tuning tool to do the tuning.
7.7. temp directory
A temp directory will be created while building the tuned image.
7.8. build_fcp.bat file
The build_fcp.bat file generates the tuned image. Once the audio tuning is done and the tunings
s