Merge branch 'master' of git.ti.com:dense-linear-algebra-libraries/linalg
[dense-linear-algebra-libraries/linalg.git] / readme.txt
1 Build instructions of LINALG component:
3 1.--------- Set environment variables ---------
5 Following environment vaialbes must be set in order to build LINALG (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 LIBARCH_DIR="<COMPONENTS_INSTALLATION_ROOT>/libarch_1_0_0_0"
17 export PATH=<TI_CGT_INSTALLATION_ROOT>/cgt-c6x/bin:$PATH
19 2.--------- Build LINALG source code and make it a RTSC package ---------
21 From the root folder of LINALG, the build command is:
22 make -f build/Makefile MEM_MODEL=<memory_model_name> TARGET=<target_name> LIBOS=<os_name>
24 where:
25    1) <memory_model_name> must be one of Large, Medium, or Small
26    2) <target_name> must be one of SOC_K2H, SOC_C6678, or SOC_AM572x
27    3) <os_name> must be one of LIB_OPENCL or LIB_RTOS
29 Examples:
30 1) to build LINALG large memory model for K2H in OpenCL environment, type:
31 make -f build/Makefile MEM_MODEL=Large TARGET=SOC_K2H LIBOS=LIB_OPENCL
33 2) to build LINALG small memory model for C6678 in RTOS environment, type:
34 make -f build/Makefile MEM_MODEL=Small TARGET=SOC_C6678 LIBOS=LIB_RTOS
36 3.--------- Build LINALG examples ---------
38 1) Install the LINALG package generated in previous step by unzipping the package file in folder ./exports:
39    - linalg_<version>.zip 
40    
41 2) Add one more environment variable to point to LINALG's path:
42 export LINALG_DIR="<LINALG installation folder>"
44 3) Go to examples folder and use build command:
45    1) For ARM+DSP: cd arm+dsp; make
46    1) For DSP-only: cd dsponly; make TARGET=<target_name> LIBOS=LIB_RTOS
47       where: <target_name> must be one of SOC_K2H, SOC_C6678, or SOC_AM572x