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