summaryrefslogtreecommitdiff
path: root/cesar/test_general/dataplane/doc.rst
blob: 341423412285431a00f563acae5a8f44b72ade9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
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.