Merged PASDK 1.2.4 changes. Fixed following bugs:
[processor-sdk/performance-audio-sr.git] / docs / readme.txt
1 Library Architecture and Framework (LibArch) build instructions. 
3 1.--------- Set environment variables ---------
5 Following environment vaialbes must be set in order to build LibArch (version numbers are used as examples):
7 export CGTROOT="<TI_CGT_INSTALLATION_ROOT>/cgt-c6x"
8 export PDK_DIR="<COMPONENTS_INSTALLATION_ROOT>/pdk_c667x_2_0_1"
9 export FC_DIR="<COMPONENTS_INSTALLATION_ROOT>/framework_components_3_40_01_04"
10 export XDAIS_DIR="<COMPONENTS_INSTALLATION_ROOT>/xdais_7_24_00_04"
11 export BIOS_DIR="<COMPONENTS_INSTALLATION_ROOT>/bios_6_45_01_29"
12 export OMP_DIR="<COMPONENTS_INSTALLATION_ROOT>/openmp_dsp_c667x_2_02_00_02"
13 export XDC_DIR="<COMPONENTS_INSTALLATION_ROOT>/xdctools_3_32_00_06_core"
14 export IPC_DIR="<COMPONENTS_INSTALLATION_ROOT>/ipc_3_42_00_02"
15 export EDMA3_DIR="<COMPONENTS_INSTALLATION_ROOT>/edma3_lld_02_12_01_23"
16 export PATH=<TI_CGT_INSTALLATION_ROOT>/cgt-c6x/bin:$PATH
18 2.--------- Build LibArch RTSC package ---------
20 From the root folder of LibArch, the build command is:
21 make -f build/Makefile TARGET=<target_name> LIBOS=<os_name>
23 where:
24    1) <target_name> must be one of SOC_K2H, SOC_C6678, SOC_AM572x, or SOC_K2G
25    2) <os_name> must be one of LIB_OPENCL or LIB_RTOS
27 Examples:
28 1) to build LibArch for K2H in OpenCL environment, type:
29 make -f build/Makefile TARGET=SOC_K2H LIBOS=LIB_OPENCL
31 2) to build LibArch for C6678 in RTOS environment, type:
32 make -f build/Makefile TARGET=SOC_C6678 LIBOS=LIB_RTOS
34 The generated LibArch RTSC package is a .zip file in the exports folder. 
36 3.--------- Build LibArch examples for K2H, C6678, AM572x ---------
37 1) Install the LibArch package generated in previous step by unzipping the package file in folder ./exports:
38    - libarch_<version>.zip
39    
40 2) Add one more environment variable to point to LibArch's path:
41 export LIBARCH_DIR="<LibArch installation folder>"
43 3) Go to examples folder and use build command:
44 make TARGET=<target_name> LIBOS=<os_name>
46 where: 
47    1) <target_name> must be one of SOC_K2H, SOC_C6678, or SOC_AM572x
48    2) <os_name> must be one of LIB_OPENCL or LIB_RTOS
50 4.--------- Build LibArch DSP-only examples for K2G ---------
51 1) Import CCS project from: examples/dsponly/k2g/ccs_project
52 2) Make sure all RTSC products specified in project Properties->CCS General->RTSC->Products and Repositories
53    are installed properly. 
54 3) Build the project
56 5. --------- Build LibArch source code ---------
57 1) Go to <LibArch installation folder>/packages/ti/libarch/src
58 2) make TARGET=<target_name> LIBOS=<os_name>, e.g. 
59    - to build for K2G: make TARGET=SOC_K2G LIBOS=LIB_RTOS
60    - to build for AM572x: make TARGET=SOC_AM572x LIBOS=LIB_OPENCL
61 3) The generated binary is ../lib/libarch.ae66