Skip to content

Commit ae20556

Browse files
author
Amanda Butler
authored
Edit README.md
Edit file, mostly for inclusion of articles.
1 parent e9c44a8 commit ae20556

File tree

1 file changed

+46
-51
lines changed

1 file changed

+46
-51
lines changed

TESTS/network/emac/README.md

Lines changed: 46 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ To configure a device to be a CTP echo server, you need to enable the `echo-serv
88

99
## Other configuration options
1010

11-
Targets with connectivity set the target.network-default-interface-type configuration variable appropriately, either to their only interface or their most-commonly-used one. For targets that provide more than one type of connectivity, you may choose the default by overriding the target.network-default-interface-type configuration variable.
11+
Targets with connectivity set the `target.network-default-interface-type` configuration variable appropriately, either to their only interface or their most commonly used one. For targets that provide more than one type of connectivity, you may choose the default by overriding the `target.network-default-interface-type` configuration variable.
1212

1313
For Ethernet, if you want to overrride the default, set the `json` configuration to:
1414

@@ -21,7 +21,7 @@ For Ethernet, if you want to overrride the default, set the `json` configuration
2121
}
2222
```
2323

24-
For Wi-Fi set the `json` configuration to:
24+
For Wi-Fi, set the `json` configuration to:
2525

2626
```
2727
"target_overrides": {
@@ -35,16 +35,13 @@ For Wi-Fi set the `json` configuration to:
3535
}
3636
```
3737

38-
For Wi-Fi you also need to configure Wi-Fi SSID and security options to the configuration file.
38+
For Wi-Fi, you also need to configure Wi-Fi SSID and security options to the configuration file.
3939

4040

4141
Test case priorities
4242
--------------------
4343

44-
Please refer to the following table for priorities of test cases. Priorities
45-
are labeled as MUST and SHOULD. MUST means this is a requirement and
46-
therefore mandatory to pass the test. SHOULD means it is recommended to
47-
pass the test if the driver implements the feature in question.
44+
Please refer to the following table for priorities of test cases. Priorities are labeled as MUST and SHOULD. MUST means this is a requirement and therefore mandatory to pass the test. SHOULD means it is recommended to pass the test if the driver implements the feature in question.
4845

4946
| | Test case | Priority |
5047
|-----|-----------------------------------------|----------|
@@ -129,101 +126,100 @@ To verify whether the echo server is receiving CTP Ethernet frames, enable `echo
129126

130127
**Description:**
131128

132-
Test case initializes and connects the EMAC driver and the test network stack.
129+
The test case initializes and connects the EMAC driver and the test network stack.
133130

134-
**Preconditions:**
131+
**Precondition:**
135132

136-
1. Device is ready to be connected (Ethernet cable is plugged or WIFI base station is available).
133+
The device is ready to be connected. (The ethernet cable is plugged in, or a Wi-Fi base station is available).
137134

138135
**Test steps:**
139136

140-
1. Constructs the network interface
141-
142-
2. Connects the network interface
137+
1. Constructs the network interface.
138+
2. Connects the network interface.
143139

144140
**Expected result:**
145141

146-
Network interface is connected.
142+
The network interface is connected.
147143

148144
### EMAC broadcast
149145

150146
**Description:**
151147

152-
Test case tests basic broadcast functionality and resolves CTP echo server MAC address.
148+
The test case tests basic broadcast functionality and resolves CTP echo server MAC address.
153149

154-
**Preconditions:**
150+
**Precondition:**
155151

156-
1. Network interface is connected.
152+
The network interface is connected.
157153

158154
**Test steps:**
159155

160-
1. Sends three CTP broadcast messages (100 bytes each)
161-
2. Waits for three seconds
156+
1. Sends three CTP broadcast messages (100 bytes each).
157+
2. Waits for three seconds.
162158
3. Sends three CTP broadcast messages (60 bytes each).
163159
4. Listens for the CTP echo server responses.
164160
5. Stores the addresses of the echo servers if replies are received.
165161

166162
**Expected result:**
167163

168-
Echo server replies to broadcast messages. For each sent broadcast message reply is waited for three seconds. In case reply is not received sending is repeated six times before failing the test.
164+
The echo server replies to broadcast messages. For each sent broadcast message, a reply waits for three seconds. If the reply is not received, the reply is sent six more times before the test fails.
169165

170166
### EMAC unicast
171167

172168
**Description:**
173169

174-
Test case tests basic unicast functionality and that the CTP echo server replies to unicast messages.
170+
The test case tests basic unicast functionality, and the CTP echo server replies to unicast messages.
175171

176-
**Preconditions:**
172+
**Precondition:**
177173

178-
1. Network interface is connected.
174+
The network interface is connected.
179175

180176
**Test steps:**
181177

182178
1. Sends three CTP unicast messages (100 bytes each) to the CTP echo server.
183-
2. Verifies that all are replied.
179+
2. Verifies all replies.
184180

185181
**Expected result:**
186182

187-
Echo server replies to unicast messages. For each sent unicast message reply is waited for three seconds. In case reply is not received sending is repeated five times before failing the test.
183+
The echo server replies to unicast messages. For each sent unicast message, a reply waits for three seconds. If the reply is not received, it is sent five more times before the test fails.
188184

189185
### EMAC unicast frame length
190186

191187
**Description:**
192188

193-
Test case tests Ethernet frame lengths.
189+
The test case tests Ethernet frame lengths.
194190

195191
**Preconditions:**
196192

197-
1. Network interface is connected.
193+
The network interface is connected.
198194

199195
**Test steps:**
200196

201-
1. Sends CTP unicast messages with Ethernet message length from 100 bytes to the maximum defined by the MTU of the EMAC with 50 bytes increments.
202-
2. Verifies that all are replied.
197+
1. Sends CTP unicast messages with Ethernet message length from 100 bytes to the maximum defined by the MTU of the EMAC with 50-byte increments.
198+
2. Verifies all replies.
203199

204200
**Expected result:**
205201

206-
Echo server replies to messages that are sent to it. For each sent unicast message reply is waited for 500ms. In case reply is not received sending is repeated five times before failing the test.
202+
The echo server replies to messages that are sent to it. For each sent unicast message, a reply waits for 500ms. If the reply is not received, it is sendt again five more times before the test fails.
207203

208204
### EMAC unicast burst
209205

210206
**Description:**
211207

212-
Test case tests Ethernet echoing at full speed.
208+
The test case tests Ethernet echoing at full speed.
213209

214-
**Preconditions:**
210+
**Precondition:**
215211

216-
1. Network interface is connected.
212+
The network interface is connected.
217213

218214
**Test steps:**
219215

220-
1. Sends CTP unicast messages with Ethernet message length from 100 bytes to the maximum defined by the MTU of the EMAC with 50 bytes increments.
216+
1. Sends CTP unicast messages with Ethernet message length from 100 bytes to the maximum defined by the MTU of the EMAC with 50-byte increments.
221217
2. Repeats the sending 10 times.
222-
3. Verifies that all are replied.
218+
3. Verifies all replies.
223219

224220
**Expected result:**
225221

226-
Echo server replies to messages that are sent to it. For each sent unicast message reply is waited for five seconds. In case reply is not received sending is repeated five times before failing the test.
222+
The echo server replies to messages that are sent to it. For each sent unicast message, a reply waits for five seconds. If the reply is not received, it is sent again five more times before the test fails.
227223

228224
### EMAC unicast long
229225

@@ -233,27 +229,27 @@ Test case tests Ethernet echoing at full speed for an extended time.
233229

234230
**Preconditions:**
235231

236-
1. Network interface is connected.
232+
The network interface is connected.
237233

238234
**Test steps:**
239235

240236
1. Sends CTP unicast messages with random Ethernet message length.
241-
2. Repeats the sending 50000 times.
242-
3. Verifies that all are replied.
237+
2. Repeats the sending 50,000 times.
238+
3. Verifies all replies.
243239

244240
**Expected result:**
245241

246-
Echo server replies to messages that are sent to it. For each sent unicast message reply is waited for 350ms. In case reply is not received sending is repeated five times before failing the test.
242+
The echo server replies to messages that are sent to it. For each sent unicast message, a reply waits for 350ms. If the reply is not received, it is sent five more times before the test fails.
247243

248244
### EMAC multicast filter
249245

250246
**Description:**
251247

252-
Test case tests multicast filtering. Multicast filtering is an optional feature for the EMAC. The test does not fail if filtering is not implemented.
248+
The test case tests multicast filtering. Multicast filtering is an optional feature for the EMAC. The test does not fail if filtering is not implemented.
253249

254-
**Preconditions:**
250+
**Precondition:**
255251

256-
1. Network interface is connected.
252+
The network interface is connected.
257253

258254
**Test steps:**
259255

@@ -266,24 +262,24 @@ Test case tests multicast filtering. Multicast filtering is an optional feature
266262

267263
**Expected result:**
268264

269-
Echo server replies to are received as expected by the test step. Supporting of the filtering will affect what messages are received.
265+
The echo server replies are received as expected by the test step. Supporting of the filtering will affect what messages are received.
270266

271267
### EMAC memory
272268

273269
**Description:**
274270

275-
Test case tests memory manager out-of-memory situations. The test case configures the test memory manager to reject memory buffer allocations made by the EMAC. Memory buffer allocations are divided into output and input memory allocations:
271+
The test case tests memory manager out-of-memory situations. The test case configures the test memory manager to reject memory buffer allocations made by the EMAC. Memory buffer allocations are divided into output and input memory allocations:
276272

277-
- The output memory allocations are the ones made by the EMAC in the \`link\_out()\` function called by the network stack (test case).
273+
- The output memory allocations are the ones made by the EMAC in the ``\`link\_out()\`` function called by the network stack (test case).
278274
- The input memory allocations are other memory allocations made by the EMAC.
279275

280276
Depending on the EMAC implementation, it may or may not allocate memory manager buffers in the link output function. If the memory manager buffers are not allocated, disabling the link output memory allocations in the test does not affect the functionality.
281277

282-
In each test step, the test case sends CTP unicast messages with Ethernet message length from 100 bytes to the maximum defined by the MTU of the EMAC with 50 bytes increments. Memory buffers sent to the EMAC in the \`link\_out()\` function are forced to be non-aligned in this test case.
278+
In each test step, the test case sends CTP unicast messages with Ethernet message length from 100 bytes to the maximum defined by the MTU of the EMAC with 50-byte increments. Memory buffers sent to the EMAC in the ``\`link\_out()\`` function are forced to be nonaligned in this test case.
283279

284-
**Preconditions:**
280+
**Precondition:**
285281

286-
1. Network interface is connected.
282+
The network interface is connected.
287283

288284
**Test steps:**
289285

@@ -298,5 +294,4 @@ In each test step, the test case sends CTP unicast messages with Ethernet messag
298294

299295
**Expected result:**
300296

301-
Echo server replies to messages that are sent to it based on whether the driver can allocate memory for frame or not. For each sent unicast message reply is waited for 500ms. In case reply is not received sending is repeated three times. If test expects that memory should be available and sending fails three times, test is failed.
302-
297+
The echo server replies to messages that are sent to it based on whether the driver can allocate memory for the frame or not. For each sent unicast message, a reply waits for 500ms. If the reply is not received, it is sent another three times. If the test expects that memory should be available and sending fails three times, the test fails.

0 commit comments

Comments
 (0)