Add code build and install instructions
[processor-sdk/performance-audio-sr.git] / readme_code_install_and_build.txt
1 Update log:
2     10-04-16: Initial version
5 Code installation:
6     Open Git bash in C:\ti
7     
8     Clone "ddp_demo" repository into processor_audio_sdk_1_00_00_00 folder.
9         $ git clone git@gitorious.design.ti.com:dolby-harmonious/ddp_demo.git processor_audio_sdk_1_00_00_00
10         
11     Checkout dev_pasdk_frank branch. Later this will be another branch or tag which tracks all desired submodules.
12         $ cd processor_audio_sdk_1_00_00_00
13         $ git checkout dev_pasdk_frank
14         
15     Update submodules. This will clone and checkout: 
16         (1) Dolby IP submodules in processor_audio_sdk_1_00_00_00\dolby_ip
17         (2) paf submodules in processor_audio_sdk_1_00_00_00\pasdk\paf
18         
19         $ git submodule update --recursive --init
20         
21 Code build:
22     Open DOS shell
23         > cd C:\ti\processor_audio_sdk_1_00_00_00
24         > setup_env.bat
25     Set ARCH to a15 in C:\ti\processor_audio_sdk_1_00_00_00\pasdk\paf\pa\build\target.mk
26         > build_paf_libs.bat ARM
27     Set ARCH to c66x in C:\ti\processor_audio_sdk_1_00_00_00\pasdk\paf\pa\build\target.mk
28         > build_paf_libs.bat DSP
29     Build algorithm libraries. This will build BMDA, CAR, DDP, MAT-THD, and OAR (DAP is currently excluded).
30         > build_alg_libs.bat
32     Open DOS shell, build UART LLD
33         > cd C:\ti\processor_audio_sdk_1_00_00_00\psdk_cust\pdk_k2g_1_0_1_0_eng\packages
34         > cd ti\drv\uart
35         > gmake clean
36         > gmake all
38     Launch CCS, add pasdk_cust to RTSC search path
39         Window->Preferences
40         Open "Code Composer Studio" menu
41         Open "RTSC" sub-menu
42         Click on "Products"
43         Click on "Add" button to right-hand side of "Product Discovery Path" window.
44         In "folder", add C:/ti/processor_audio_sdk_1_00_00_00/psdk_cust
46     Platform lib: see C:\ti\processor_audio_sdk_1_00_00_00\docs\PASDK_setup_guide.pdf
47     DSP application: see C:\ti\processor_audio_sdk_1_00_00_00\docs\PASDK_setup_guide.pdf
48     ARM application: see C:\ti\processor_audio_sdk_1_00_00_00\docs\PASDK_setup_guide.pdf
50 Obtain status for all submodules:    
51     $ git submodule foreach --recursive git status
53 Obtain status for ddp_demo repository and all submodules:
54     git status && git submodule foreach --recursive git status
56 How to change submodule version tracked by super-repo:
57     $ cd <submodule path>, e.g. cd /c/ti/processor_audio_sdk_1_00_00_00/dolby_ip/mat-thd
58     $ git checkout dev_psdkaudio_qin
59     
60     Show status:
61     $ cd ../..
62     $ git status
63     
64     Update super-repo branch to track updated submodule:
65     $ git checkout -b dev_pasdk_qin // this created a new branch in the "ddp_demo" or super-repo
66     $ git add dolby_ip/mat-thd
67     $ git commit -m "<comment>"
68     $ git push origin dev_pasdk_qin