Updated the Readme
[dante-enablement/k2g-dante-enablement.git] / README
1 The dante enablement project demostrates the pro audio Dante software\r
2 running on TI ARM Cortex-A15 platformsa in loopback mode.\r
3 \r
4 There are 2 types of loopback in the demo:\r
5 \r
6    1) ARM-only loopback: In this loopback type, audio samples received from\r
7       network will loopback in ARM GPU and out to netowrk.\r
8    2) DSP loopback: In DSP loopback, the audi samples will be offloaded to\r
9       DSP and loopback in DSP back to ARM GPU, then out to network\r
10 \r
11 There are 5 patch files provided: \r
12 - Patch 1 is needed by the DEP container.\r
13 - Patches 2 through 4 are needed for kernel optimizations for interrupt pacing,\r
14   and additional overhead removal for the scheduling\r
15 - Patch 5 is needed for the DSP loopback application.\r
16 \r
17 1) 0001-linux-KConfig-Enable-Dante-required-CGROUP-and-Names.patch\r
18 \r
19    Dante Enabled Platform (DEP) container requires RT-Linux and \r
20    CGROUP and Namespace support. Hence, this patch file reflects the\r
21    needed features in RT-Linux kernel which are not included in the \r
22    default setting. The change is based on kernel 4.19.59 (Linux \r
23    Processor SDK 06.01 release).\r
24 \r
25    RT-Linux kernel needs to rebuilt after the patch file is applied.\r
26 \r
27 2) 0002-k2g-defconfig-disable-RPS-and-XPS.patch\r
28    k2g: defconfig: disable RPS and XPS\r
29    \r
30 3) 0003-soc-ti-knav_qmss-k2g-make-rx-tx-irq-no-thread-on-rt.patch\r
31     Networking RX/TX IRQs are simple and used to schedule NAPI, so making them\r
32     NOTHREAD allows to avoid additional scheduling\r
33 \r
34     IRQ\r
35      |- threaded irq <--avoid\r
36         |-schedule NAPI (ksoftirqd)\r
37     \r
38 4) 0004-drivers-net-ethernet-ti-netcp_core.c-tx-tmr.patch\r
39    This patch is needed for interrupt pacing enable for Transmit and Receive\r
40 \r
41    a. Apply patch to PLSDK:\r
42       $ cd <plsdk_linux-rt-k2g-installed-dir>/board-support/linux-rt-[version]\r
43       $ patch < 0001-linux-KConfig-Enable-Dante-required-CGROUP-and-Names.patch \r
44       $ patch < 0002-k2g-defconfig-disable-RPS-and-XPS.patch \r
45       $ patch < 0003-soc-ti-knav_qmss-k2g-make-rx-tx-irq-no-thread-on-rt.patch\r
46       $ patch < 0004-drivers-net-ethernet-ti-netcp_core.c-tx-tmr.patch \r
47             \r
48    b. Rebuilt rt-linux\r
49 \r
50    Add the SDK's toolchain to the PATH environment variable and build the kernel image\r
51       $ export PATH=<sdk path>/linux-devkit/sysroots/x86_64-arago-linux/usr/bin:$PATH\r
52       $ cd <plsdk_linux-rt-k2g-installed-dir>/board-support/linux-rt-<version>\r
53       $ make ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- tisdk_k2g-evm-rt_defconfig\r
54       $ make -j8 ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- zImage\r
55       $ make -j8 ARCH=arm CROSS_COMPILE=arm-linux-gnueabihf- modules\r
56       $ cd <plsdk_linux-rt-k2g-installed-dir>\r
57       $ make cmem-mod\r
58       $ make uio_module_drv\r
59 \r
60    Copy arch/arm/boot/zImage to the /boot/zImage on K2G SD card\r
61    \r
62    Install the Kernel modules onto SD card at rootfs mount point\r
63       $make ARCH=arm INSTALL_MOD_PATH=<path_to_rootfs> modules_install\r
64    \r
65    Copy UIO driver module to the SD card in the rootfs\r
66       $cp <plsdk_linux-rt-k2g-installed-dir>/board-support/extra-drivers/uio-module-drv/uio-module-drv.ko <path_to_rootfs>/lib/modules/<kernel_version>/extra/uio-module-drv.ko\r
67 \r
68    Copy CMEM driver module to the SD card in the rootfs\r
69       $cp <plsdk_linux-rt-k2g-installed-dir>/board-support/extra-drivers/cmem-mod/module/cmemk.ko <path_to_rootfs>/lib/modules/<kernel_version>/extra/cmemk.ko\r
70 \r
71    Please see detailed build instruction in PLSDK Kernel User Guide:\r
72    http://software-dl.ti.com/processor-sdk-linux/esd/docs/latest/linux/Foundational_Components_Kernel_Users_Guide.html\r
73 \r
74 2) dante-loopback-dsp.patch\r
75 \r
76    This patch file is only needed if doing DSP loopback. This patch\r
77    enables the offload of audio samples to DSP, and back to ARM GPU.\r
78    The offload of audio samples allows further processing of audio\r
79    samples in DSP core. The change is based on DEP 0.9 Beta release.\r
80 \r
81    a. Apply patch on DEP package installed on K2G\r
82       # copy dante-loopback-dsp.patch to /home/root/dep\r
83       # cd /home/root/dep/example\r
84       # patch < -p5 dante-loopback-dsp.patch\r
85 \r
86    b. Build loopback example for ARM-only\r
87       # cd /home/root/dep/example/audio\r
88       # make clean\r
89       # make\r
90 \r
91 3. Build loopback example with DSP enablement\r
92       # cd /home/root/dep/example/audio\r
93       # make -f Makefile.opcl clean\r
94       # make -f Makefile.opcl\r
95 \r