diff mbox

[PATCHv13,9/9] linux-generic: ipc pktio: add description

Message ID 1447331786-13461-10-git-send-email-maxim.uvarov@linaro.org
State New
Headers show

Commit Message

Maxim Uvarov Nov. 12, 2015, 12:36 p.m. UTC 
Add description for ipc pktio.

Signed-off-by: Maxim Uvarov <maxim.uvarov@linaro.org>
---
 platform/linux-generic/pktio/ipc.README | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 platform/linux-generic/pktio/ipc.README
diff mbox

Patch

diff --git a/platform/linux-generic/pktio/ipc.README b/platform/linux-generic/pktio/ipc.README
new file mode 100644
index 0000000..a76975d
--- /dev/null
+++ b/platform/linux-generic/pktio/ipc.README
@@ -0,0 +1,22 @@ 
+/* Copyright (c) 2015, Linaro Limited
+ * All rights reserved.
+ *
+ * SPDX-License-Identifier:     BSD-3-Clause
+ */
+
+IPC pktio for linux-generic (over shm)
+
+* Propose
+ IPC pktio is used to do fast packet exchange between processes. In current implementation
+ pools are shared between processes and odp ring is used for sending pointers for packets
+ as offset in the pool decoded in odp_packet_t bits.
+
+* Usage
+ Please refer to current examples. In general in both processes you need initialization
+ with same pool and pktio name parameters.
+
+* Limitations
+ - for now only 2 processes supported. (will updated in future).
+ - both processes has to be on same node and able to mmap() the same shared memory.
+ - fake mac address (same as for loop).
+ - mtu is only limited by pool settings.