Added OAR and BMDA path in the include options.
[processor-sdk/performance-audio-sr.git] / readme_demo.txt
1 Update log:
2     06-20-16: Initial version
3     06-27-16: Add information on code installation & build
4     06-30-16: Add note concerning PAF Makefile ROOTDIR variable
5     07-08-16: Add information on UART LLD build
6     07-14-16: Add note concerning <root>
7     08-04-16: Add DDP(JOC), OAR and BMDA
8     08-11-16: Add workaround in OAR
9     
10 NOTE: Below mentioned <root> has only been verified for <root>=c:\ti.
11       Using another <root> will require changes to makefiles (e.g. DDP, Intrinsics)
12       hard-coded to use c:\ti.
13     
14     Code installation:
15         IPC: Unzip ipc_3_43_00_00_eng.zip (contains IPC engineering release) to <root>\ipc_3_43_00_00_eng\.
16         
17         PAF: 
18             Git repo: git@gitorious.design.ti.com:dolby-harmonious/os_paf_dev.git
19             Branch: dev_psdkaudio_qin
20             Commit: 941aaf7
21             
22             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\paf\.
23             
24         Dolby Intrinsics: 
25             Git repo: git@gitorious.design.ti.com:dolby-harmonious/intrinsics.git
26             Branch: pp_harmonious_dev
27             Commit: 7c60646
28             
29             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\intrinsics\.
30             
31         DDP: 
32             Git repo: git@gitorious.design.ti.com:dolby-harmonious/ddp.git
33             Branch: pp_harmonious_dev
34             Commit: ab55d5b
35             
36             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\ddp\.
38         OAR: 
39             Git repo: git@gitorious.design.ti.com:dolby-harmonious/oar.git
40             Branch: dev_psdkaudio_qin
41             Commit: 5597ca3
42             
43             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\oar\.
45         BMDA: 
46             Git repo: git@gitorious.design.ti.com:dolby-harmonious/bmda.git
47             Branch: dev_psdkaudio_qin
48             Commit: 55fada2
49             
50             Clone Git repo into <root>\procsdk_audio_x_xx_xx_xx\bmda\.
53     Build instructions:
54         PAF:
55             Rebuild paf libraries:
56                 1) Update <root>\procsdk_audio_x_xx_xx_xx\setup_env.bat for local environment.
57                 2) Open DOS shell.
58                 3) From DOS prompt, execute:
59                     > setup_env.bat
60                 4) Add ROOTDIR variable pa/build/target.mk, e.g.
61                     export ROOTDIR = C:\ti\procsdk_audio_x_xx_xx_xx\paf
62                 5) Modify ARCH variable in pa/build/target.mk to select c66x target
63                 6) From DOS prompt, execute:
64                     > build_libs.bat DSP
65                 6) Modify ARCH variable in pa/build/target.mk to select a15 target
66                 7) From DOS prompt, execute:
67                     > build_libs.bat ARM
70         DDP:
71             Rebuild DDP libraries:
72                 1) Open DOS prompt
73                 2) cd <root>\ddp\Dolby_Digital_Plus_Decoder_Imp\Source_Code\make\ddp_udc_lib\a15
74                 3) Execute:
75                     > gmake
76                 3) cd <root>\ddp\Dolby_Digital_Plus_Decoder_Imp\Source_Code\make\ddp_udc_wrapper\a15
77                 4) From DOS prompt, execute:
78                     > gmake
79             
80          OAR:
81             Rebuild OAR libraries:
82                 1) Open DOS prompt
83                 2) cd <root>\oar\CCS_OAR_lib\make
84                 3) Execute:
85                     > gmake
86   
87         BMDA:
88             Rebuild BMDA libraries:
89                 1) Open DOS prompt
90                 2) cd <root>\bmda\Source_Code\make
91                 3) Execute:
92                     > gmake SHELL=%ComSpec%
93             Note: Set "export ARCH = c66x" in target.mk to build BMDA library.
94                 
96        UART LLD:
97             1) Open DOS prompt
98             2) cd <root>\pdk_k2g_1_0_1\packages
99             3) Execute:
100                 > pdksetupenv.bat
101             4) cd ti\drv\uart
102             5) Execute:
103                 > gmake all
104             
105         Platform lib:
106             1) Import CCS project into workspace located in <root>\pdk_k2g_1_0_1\packages\ti\platform\evmk2g\platform_lib\.
107             2) Rebuild project, Debug build profile
108             
109         DSP application:
110             1) Import CCS project into workspace located in <root>\procsdk_audio_x_xx_xx_xx\test_dsp\.
111             2) Rebuild project, Debug build profile
112         
113         ARM application:
114             1) Import CCS project into workspace located in <root>\procsdk_audio_x_xx_xx_xx\test_arm\.
115             2) Rebuild project, Debug build profile