Add code build and install instructions
authorFrank Livingston <frank-livingston@ti.com>
Tue, 4 Oct 2016 22:32:25 +0000 (17:32 -0500)
committerFrank Livingston <frank-livingston@ti.com>
Tue, 4 Oct 2016 22:32:25 +0000 (17:32 -0500)
readme_code_install_and_build.txt [new file with mode: 0644]

diff --git a/readme_code_install_and_build.txt b/readme_code_install_and_build.txt
new file mode 100644 (file)
index 0000000..9cd0ac5
--- /dev/null
@@ -0,0 +1,68 @@
+Update log:
+    10-04-16: Initial version
+
+
+Code installation:
+    Open Git bash in C:\ti
+    
+    Clone "ddp_demo" repository into processor_audio_sdk_1_00_00_00 folder.
+        $ git clone git@gitorious.design.ti.com:dolby-harmonious/ddp_demo.git processor_audio_sdk_1_00_00_00
+        
+    Checkout dev_pasdk_frank branch. Later this will be another branch or tag which tracks all desired submodules.
+        $ cd processor_audio_sdk_1_00_00_00
+        $ git checkout dev_pasdk_frank
+        
+    Update submodules. This will clone and checkout: 
+        (1) Dolby IP submodules in processor_audio_sdk_1_00_00_00\dolby_ip
+        (2) paf submodules in processor_audio_sdk_1_00_00_00\pasdk\paf
+        
+        $ git submodule update --recursive --init
+        
+Code build:
+    Open DOS shell
+        > cd C:\ti\processor_audio_sdk_1_00_00_00
+        > setup_env.bat
+    Set ARCH to a15 in C:\ti\processor_audio_sdk_1_00_00_00\pasdk\paf\pa\build\target.mk
+        > build_paf_libs.bat ARM
+    Set ARCH to c66x in C:\ti\processor_audio_sdk_1_00_00_00\pasdk\paf\pa\build\target.mk
+        > build_paf_libs.bat DSP
+    Build algorithm libraries. This will build BMDA, CAR, DDP, MAT-THD, and OAR (DAP is currently excluded).
+        > build_alg_libs.bat
+
+    Open DOS shell, build UART LLD
+        > cd C:\ti\processor_audio_sdk_1_00_00_00\psdk_cust\pdk_k2g_1_0_1_0_eng\packages
+        > cd ti\drv\uart
+        > gmake clean
+        > gmake all
+
+    Launch CCS, add pasdk_cust to RTSC search path
+        Window->Preferences
+        Open "Code Composer Studio" menu
+        Open "RTSC" sub-menu
+        Click on "Products"
+        Click on "Add" button to right-hand side of "Product Discovery Path" window.
+        In "folder", add C:/ti/processor_audio_sdk_1_00_00_00/psdk_cust
+
+    Platform lib: see C:\ti\processor_audio_sdk_1_00_00_00\docs\PASDK_setup_guide.pdf
+    DSP application: see C:\ti\processor_audio_sdk_1_00_00_00\docs\PASDK_setup_guide.pdf
+    ARM application: see C:\ti\processor_audio_sdk_1_00_00_00\docs\PASDK_setup_guide.pdf
+
+Obtain status for all submodules:    
+    $ git submodule foreach --recursive git status
+
+Obtain status for ddp_demo repository and all submodules:
+    git status && git submodule foreach --recursive git status
+
+How to change submodule version tracked by super-repo:
+    $ cd <submodule path>, e.g. cd /c/ti/processor_audio_sdk_1_00_00_00/dolby_ip/mat-thd
+    $ git checkout dev_psdkaudio_qin
+    
+    Show status:
+    $ cd ../..
+    $ git status
+    
+    Update super-repo branch to track updated submodule:
+    $ git checkout -b dev_pasdk_qin // this created a new branch in the "ddp_demo" or super-repo
+    $ git add dolby_ip/mat-thd
+    $ git commit -m "<comment>"
+    $ git push origin dev_pasdk_qin