summaryrefslogtreecommitdiff
path: root/cesar/test_general
diff options
context:
space:
mode:
Diffstat (limited to 'cesar/test_general')
-rw-r--r--cesar/test_general/dataplane/Makefile13
-rw-r--r--cesar/test_general/dataplane/doc-Makefile3
-rw-r--r--cesar/test_general/dataplane/doc.rst72
3 files changed, 87 insertions, 1 deletions
diff --git a/cesar/test_general/dataplane/Makefile b/cesar/test_general/dataplane/Makefile
index 4469ade2ed..3928870f13 100644
--- a/cesar/test_general/dataplane/Makefile
+++ b/cesar/test_general/dataplane/Makefile
@@ -1,3 +1,14 @@
-all clean:
+all:
$(MAKE) -f maximus-Makefile $@
$(MAKE) -f sparc-Makefile $@
+
+clean:
+ $(MAKE) -f maximus-Makefile $@
+ $(MAKE) -f sparc-Makefile $@
+ rmdir obj
+
+pdf:
+ $(MAKE) -f doc-Makefile $@
+
+pdf-clean:
+ $(MAKE) -f doc-Makefile clean
diff --git a/cesar/test_general/dataplane/doc-Makefile b/cesar/test_general/dataplane/doc-Makefile
new file mode 100644
index 0000000000..c7a99e4b09
--- /dev/null
+++ b/cesar/test_general/dataplane/doc-Makefile
@@ -0,0 +1,3 @@
+BASE = ../../..
+DOCS = doc
+include $(BASE)/common/doc/template/doc.mk
diff --git a/cesar/test_general/dataplane/doc.rst b/cesar/test_general/dataplane/doc.rst
new file mode 100644
index 0000000000..3414234122
--- /dev/null
+++ b/cesar/test_general/dataplane/doc.rst
@@ -0,0 +1,72 @@
+==============
+Test dataplane
+==============
+
+.. |title| replace:: Test dataplane
+.. |version| vcs-version::
+
+.. include:: header.rst
+
+This test is used to configure two boards to send data over PLC without
+having a Control plane.
+
+How to use
+**********
+
+Use with maximus
+----------------
+
+The first important information is that using this test with maximus is
+useless because it will only configure the data path to send data and will
+exit. No output will be printed if the test is successful.
+
+This can only be useful to verify that the data path compiles and can be
+configured by a real Control Plane.
+
+Compile:
+
+ 1. Compile maximus -> make -C ../../maximus/python
+ 2. Compile the station -> make
+
+Use on boards
+-------------
+
+The python script will configure the data path to send and receive data over
+the PLC without any control from the Control Plane (it is not compiled at all).
+So you can change the tonemaps, ping from one computer to another one, change
+the tonemask, make some tests without the CP to disturb.
+
+Launch the scripts
+------------------
+
+Two scripts are available in py directory and written in python:
+
+ - basic.py
+ - trace.py
+
+The first one will configure the boards, the second one will dump traces
+from the boards.
+
+To use it you will need to inform the script if you will run the test on
+maximus (--maximus option) or on board (--mme option). You will need to
+provide the bridge table and the TEI corresponding to the mac address
+provided.
+
+PC1 ------ B1 ~~~~~~ B2 ------ PC2
+
+Assuming the B1 has TEI 1 and B2 has TEI 2. You will need to give the
+following options to run the test.
+
+-b <board 1 TEI> <Mac address bridged 1> <Mac address bridged 2> ... -b
+<board 2 TEI> <Mac address bridged 1> ...
+
+So for example using pessac eth1 interface and muralhas eth1 interface, the
+command line to run the test is.
+
+Pessac eth1 Mac @ (PC1): 84:2b:2b:50:55:8e
+
+Muralhas eth1 Mac @ (PC2): 00:14:d1:17:5c:fb
+
+python py/basic.py --mme -b 1 00:14:d1:17:5c:fb -b 2 84:2b:2b:50:55:8e
+
+run python py/basic.py -h to have all available options.