===== Building System Controller Firmware for @stk_name@ and Intergation into the BSP =====

==== Prerequisites ====

  * BSP revison @bsp_version@ built according to [[@lang@:@mod_arch@:@mod_name@:@bsp_name@:@build_system@:quickstart_yocto| quickstart guide]]
  * Request [[Support@tq-group.com?subject=[SCFW Patch Series] | SCFW Patch Series]] from TQ Support. Please specifiy the BSP Revision in the request.



==== Setup Development Host ====

=== Install additional Packages === 

The tools cppcheck and srec_cat must be installed on the development host to build the System Controller Firmware, on a Ubuntu host they can be installed with the following command:

<code>
sudo apt-get install srecord cppcheck
</code>   


=== Download and Install GNU ARM Toolchain ===

Download the [[@gnu_arm_toolchain_link@|GNU Arm Embedded Toolchain @gnu_arm_toolchain_ver@]]


<code> 
cd ~/Downloads
wget @gnu_arm_toolchain_link@
sudo tar xvjf @gnu_arm_toolchain_archive@ -C /opt
</code>

=== SCFW Patch Series ===

In this guide the SCFW patch series provided from TQ is stored in the current users **Download** folder. One can choose any other location in the home directory. 
 


==== Download and Install SCFW Porting Kit ====

The SCFW porting kit download requires the registration on the NXP website, afterwards it can be downloaded from the link below: 

[[@scfw_porting_kit_dl_link@]]

Create a new folder for the SCFW porting kit e.g. in the home directory 

<code>
mkdir -p ~/workspace/scfw
</code>

Extract the SCFW porting kit archive to the folder created above. 

<code>
cd ~/Downloads
tar xvzf @scfw_porting_kit_archive@ -C ~/workspace/scfw/ 
</code>

Navigate to folder "packages" in the scfw directory and make the SCFW proting kit binary executable.
Start the SCFW Porting Kit afterwards and read/accept the NXP EULA.

<code>
cd ~/workspace/scfw/packages
chmod +x imx-scfw-porting-kit-@scfw_ver@.bin
./imx-scfw-porting-kit-@scfw_ver@.bin
</code>

Navigate to subfolder src/ in the new created folder imx-scfw-porting-kit-@scfw_ver@ and extract the source archives 

<code>
cd imx-scfw-porting-kit-@scfw_ver@/src/
for FILE in *.tar.gz ; do tar xvzf $FILE; done
</code>

Move back to root folder imx-scfw-porting-kit-@scfw_ver@ and initialize the SCFW porting kit as git repository.

<code>
cd ..
git init
</code>

Add all files to the git repository created before and create an inital commit

<code>
git add .
git commit -m "initial commit"
</code>

Check the git repository status:  

<code>
git status 
</code>

An output on the shell that the working tree is clean should appear and look like something below:

<code>
On branch master
nothing to commit, working tree clean
</code>

Extract porting-kit patch archive into your scfw root directory:

e.g.

<code>
tar xvzf ~/Downloads/@imx_scfw_patch_series_name@.tar.gz -C ~/workspace/scfw/
</code>

Create **patches** variable for current shell session, e.g.:

<code>
patches=$(cat ~/workspace/scfw/@imx_scfw_patch_series_name@/series)
</code>

Patch scfw firmware repository:
<code>
for p in ${patches}; do git am ~/workspace/scfw/@imx_scfw_patch_series_name@/${p}; done
</code>

Create a new git tag with reference to the tq revision of the scu firmware, e.g.:

<code>
git tag -a @scfw_local_git_tag@-local
</code>


Build the scfw firmware using one of the following commands:

^  Build Command  ^  Description  ^
|  <code>make -f Makefile.release</code>  | Disables monitor, debug and sets TEST=NONE  |
|  <code>make -f Makefile.debug</code>  | Enables monitor, debug and sets DEBUG_LEVEL=3, TEST=all  |
|  <code>make -f Makefile.monitor</code>  | Enables monitor, debug and sets DEBUG_LEVEL=1, TEST=NONE  |
|  <code>make -f Makefile.test</code>  | Disables monitor, enables debug and sets DEBUG_LEVEL=3, allows overwrite TEST from environment  |

Copy the SCU firmware archive into the following folder in the build directory .../ci-meta-tq/sources/meta-tq/meta-tq/recipes-bsp/imx-sc-firmware/imx-sc-firmware-tq 
e.g.
<code>
cp ~/workspace/scfw/packages/imx-scfw-porting-kit-@scfw_ver@/@scfw_local_git_tag@-local.tar.gz ~/workspace/@bsp_git_tag@.@bsp_version@/ci-meta-tq/sources/meta-tq/meta-tq/recipes-bsp/imx-sc-firmware/imx-sc-firmware-tq 
</code>
Customize the **SC_FIRMWARE_VERSION_TQ** variable in the recipe file .../ci-meta-tq/sources/meta-tq/meta-tq/recipes-bsp/imx-sc-firmware/imx-sc-firmware_1.3.1.bbappend to match the SCU firmware archive naming:

<code>
SC_FIRMWARE_VERSION_TQ ?= "@scfw_local_git_tag@-local"
</code>