You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: TESTS/network/emac/README.md
+14-14Lines changed: 14 additions & 14 deletions
Original file line number
Diff line number
Diff line change
@@ -1,48 +1,48 @@
1
1
# Introduction
2
2
3
-
This document describes how to run EMAC tests. The EMAC test cases are made using the Ethernet Configuration Testing Protocol (CTP). To run the tests, one device in the Ethernet segment needs to be configured to be a CTP echo server. The devices running the test cases, use the echo server to forward the CTP Ethernet frames back.
3
+
This document describes how to run EMAC tests. The EMAC test cases are made using the Ethernet Configuration Testing Protocol (CTP). To run the tests, you need to configure one device in the Ethernet segment to be a CTP echo server. The devices running the test cases use the echo server to forward the CTP Ethernet frames back.
4
4
5
5
## Configuring the CTP echo server
6
6
7
-
To configure a device to be a CTP echo server, you need to enable the `echo-server` setting in the `json` file of the test environment application. When a device is configured to be a CTP echo server, it starts to forward CTP messages automatically when it is switched on and continues to do so until it is switched off.
7
+
To configure a device to be a CTP echo server, you need to enable the `echo-server` setting in the `json` file of the test environment application. When you configure a device to be a CTP echo server, it starts to forward CTP messages automatically when it is on and continues to do so until you switch it off.
8
8
9
9
## Other configuration options
10
10
11
-
Default configuration files included with tests are configured for ethernet. For Wifi, set `test-ethernet` to 0 and `test-wifi` to 1. Also Wifi SSID and security options need to be configured to the configuration file.
11
+
Default configuration files included with tests are configured for ethernet. For Wi-Fi, set `test-ethernet` to 0 and `test-wifi` to 1. You also need to configure Wi-Fi SSID and security options to the configuration file.
12
12
13
13
## Example commands
14
14
15
15
### CTP echo server
16
16
17
-
You can use following command to build CTP echo server:
17
+
You can use the following command to a build CTP echo server:
Replace TARGET with the target device. After building, flash the binary to the CTP echo server device.
22
22
23
-
You can verify that the CTP echo server has been started properly by making terminal connection to the device, resetting it and verifying that `echo server started successfully`is printed on the terminal. Host tests can be run when the CTP echo server is running on the Ethernet segment.
23
+
You can verify that the CTP echo server has started properly by making a terminal connection to the device, resetting it and verifying that `echo server started successfully`prints on the terminal. You can run host tests when the CTP echo server is running on the Ethernet segment.
24
24
25
-
For Wifi tests the CTP echo server can be also running of ethernet side as long as network configuration is such that Ethernet frames are routed between Wifi and Ethernet.
25
+
For Wi-Fi tests, the CTP echo server can also run on the ethernet side as long as the network configuration is such that Ethernet frames are routed between Wi-Fi and Ethernet.
26
26
27
-
CTP echo server is sending 100 bytes long broadcast CTP Ethernet frame every 60 seconds to inform the network of its presence.
27
+
The CTP echo server sends a 100-byte long broadcast CTP Ethernet frame every 60 seconds to inform the network of its presence.
Test cases have different trace levels based on how much tracing can be done without affecting the performance of the test case. Tracing is configured using `SET\_TRACE\_LEVEL' macro.
39
+
Test cases have different trace levels based on how much tracing can be done without affecting the performance of the test case. Configure tracing using `SET\_TRACE\_LEVEL` macro.
40
40
41
-
For example `EMAC broadcast` test enables send, input CTP frame, success and failure traces:
41
+
For example, the`EMAC broadcast` test enables send, input CTP frame, success and failure traces:
Here is an example trace about a message that has been send to broadcast address `ff:ff:ff:ff:ff:ff`and is answered by echo server:
45
+
This example trace is about a message sent to broadcast address `ff:ff:ff:ff:ff:ff`that an echo server answers:
46
46
47
47
```
48
48
@@ -52,7 +52,7 @@ response: receipt number 24 LENGTH OK DATA OK BROADCAST
52
52
53
53
```
54
54
55
-
Here is an example trace about a message that has been send to broadcast address `ff:ff:ff:ff:ff:ff`and is not answered by echo server:
55
+
This example trace is about a message sent to broadcast address `ff:ff:ff:ff:ff:ff`that an echo server does not answer:
56
56
57
57
```
58
58
@@ -62,7 +62,7 @@ NO RESPONSE: receipt number 25
62
62
63
63
```
64
64
65
-
Here is an example about input message trace, message hex dump contains the first 32 bytes of the received Ethernet frame.
65
+
This example is about input message trace. Message hex dump contains the first 32 bytes of the received Ethernet frame:
66
66
67
67
```
68
68
@@ -74,7 +74,7 @@ INP> 00000e 00 00 02 00 ba 42 ed 79 11 8a 01 00 01 00
74
74
75
75
```
76
76
77
-
If you like to verify whether the echo server is receiving CTP Ethernet frames you can enable `echo-server-trace` option in the echo server configuration file. This can be used for debugging purposes. Do not run performance test like `EMAC unicast burst` with tracing enabled, since tracing affects the echo server performance.
77
+
To verify whether the echo server is receiving CTP Ethernet frames, enable `echo-server-trace` option in the echo server configuration file. You can use this for debugging purposes. Do not run performance tests such as `EMAC unicast burst` with tracing enabled because tracing affects the echo server performance.
0 commit comments