diff mbox

[v2,11/11] Keystone2: Add README file

Message ID 1397735782-31924-12-git-send-email-taras.kondratiuk@linaro.org
State Superseded
Headers show

Commit Message

Taras Kondratiuk April 17, 2014, 11:56 a.m. UTC 
Signed-off-by: Taras Kondratiuk <taras.kondratiuk@linaro.org>
---
 platform/linux-keystone2/README |   39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 platform/linux-keystone2/README
diff mbox

Patch

diff --git a/platform/linux-keystone2/README b/platform/linux-keystone2/README
new file mode 100644
index 0000000..4dd54f3
--- /dev/null
+++ b/platform/linux-keystone2/README
@@ -0,0 +1,39 @@ 
+1. Intro
+
+OpenDataPlane implementation for TI Keystone2 SoC's. Current version supports
+HW buffer, queues and Packet IO management. This drop does not target high
+performance. It is rather proof of ODP API functionality. It still uses
+linux-generic's SW scheduler.
+
+2. Prerequisites
+
+  2.1 Linux kernel
+
+Sources: git://git.ti.com/keystone-linux/linux.git master
+config:  keystone2_defconfig
+DTB:     k2hk-evm.dtb
+
+Current implementation relies on kernel to enable and configure network
+interfaces. Implementation does not support Packet and Security accelerators
+now so they should be disable in kernel config:
+
+# CONFIG_TI_KEYSTONE_NET_SA is not set
+# CONFIG_TI_KEYSTONE_QOS is not set
+# CONFIG_TI_KEYSTONE_PA is not set
+
+  2.2 OpenEM libs and kernel module
+
+Keystone ODP uses OpenEM libraries as low level drivers.
+
+Sources: git://git.linaro.org/people/taras.kondratiuk/keystone2-odp/openem.git for_odp
+Build:   cd linux
+         make KDIR=<path/to/kernel> -f Makefile.c6638 clean mod_clean static mod
+
+3. Keystone2 ODP build
+
+make PLATFORM=linux-keystone2 OPENEM_ROOT=<openem_src_dir> clean tests_install
+
+4. Installation
+
+Before any ODP application started an OpenEM kernel module (em_mod.ko) should
+be inserted.