Update alpha header file package
[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-10-16: Update commit Ids for PAF, Dolby Intrinsics, and DDP.
9     08-11-16: Add workaround in OAR
10     
11 NOTE: Below mentioned <root> has only been verified for <root>=c:\ti.
12       Using another <root> will require changes to makefiles (e.g. DDP, Intrinsics) 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_frank
20             Commit: c24fd06
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: ab96821
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: dev_psdkaudio_frank
34             Commit: 2abeab4
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
69         DDP:
70             Rebuild DDP libraries:
71                 1) Open DOS prompt
72                 2) cd <root>\procsdk_audio_x_xx_xx_xx\ddp\Dolby_Digital_Plus_Decoder_Imp\Source_Code\make\ddp_udc_lib\a15
73                 3) Execute:
74                     > gmake
75                 3) cd <root>\procsdk_audio_x_xx_xx_xx\ddp\Dolby_Digital_Plus_Decoder_Imp\Source_Code\make\ddp_udc_wrapper\a15
76                 4) From DOS prompt, execute:
77                     > gmake
78             
79         OAR:
80             Rebuild OAR libraries:
81                 1) Open DOS prompt
82                 2) cd <root>\procsdk_audio_x_xx_xx_xx\oar\CCS_OAR_lib\make
83                 3) Execute:
84                     > gmake
85   
86         BMDA:
87             Rebuild BMDA libraries:
88                 1) Open DOS prompt
89                 2) cd <root>\procsdk_audio_x_xx_xx_xx\bmda\Source_Code\make
90                 3) Execute:
91                     > gmake SHELL=%ComSpec%
92             Note: Set "export ARCH = c66x" in target.mk to build BMDA library.
93                 
94         UART LLD:
95             1) Open DOS prompt
96             2) cd <root>\pdk_k2g_1_0_1\packages
97             3) Execute:
98                 > pdksetupenv.bat
99             4) cd ti\drv\uart
100             5) Execute:
101                 > gmake all
102             
103         Platform lib:
104             1) Import CCS project into workspace located in <root>\pdk_k2g_1_0_1\packages\ti\platform\evmk2g\platform_lib\.
105             2) Rebuild project, Debug build profile
106             
107         DSP application:
108             1) Import CCS project into workspace located in <root>\procsdk_audio_x_xx_xx_xx\test_dsp\.
109             2) Rebuild project, Debug build profile
110         
111         ARM application:
112             1) Import CCS project into workspace located in <root>\procsdk_audio_x_xx_xx_xx\test_arm\.
113             2) Rebuild project, Debug build profile