Skip to content

Commit 73f5ab9

Browse files
chintanv133chintanv133
committed
fix(CPSW): Update the CPSW documenation with Sphinx compatibility
Update the CPSW documentation to follow Sphinx conventions, note that there is no functional or content changes made. Signed-off-by: Chintan Vankar <c-vankar@ti.com>
1 parent 85ca915 commit 73f5ab9

File tree

8 files changed

+157
-167
lines changed

8 files changed

+157
-167
lines changed

‎source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS.rst‎

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Host port ingress Rate Limiting offload
2727
The netdev sysfs **tx_maxrate** parameter can be used to configure rate limit in Mbit/s per TX DMA channel.
2828
The rate for shapers has to be set a little bit more then potential incoming rate, and real rates can differ, due to discreetness.
2929

30-
::
30+
.. code:: console
3131
3232
echo 100 > /sys/class/net/eth2/queues/tx-7/tx_maxrate
3333
@@ -40,7 +40,7 @@ In this example Rate Limiting is enabled only for Host port TX channels.
4040
* pri6 traffic routed to TX DMA channel 6, rate limit 200Mbit
4141
* pri0-5 traffic routed to TX DMA channel 0
4242

43-
::
43+
.. code:: console
4444
4545
ip link set dev eth0 down
4646
ethtool -L eth0 tx 8
@@ -100,7 +100,7 @@ The MQPRIO Qdisc **shaper bw_rlimit min_rate and max_rate** parameters can be us
100100
* if Host sends traffic to the same, rate limited External Ports FIFO then corresponding Host TX DMA channel shapers has to be enabled and its rate has to be set equal or less than External Ports FIFO rate
101101
* the rate for shapers has to be set a little bit more then potential incoming rate, and real rates can differ, due to discreetness.
102102

103-
::
103+
.. code:: console
104104
105105
tc qdisc add dev eth0 parent root handle 100: mqprio num_tc 3 \
106106
map 0 0 0 0 0 0 1 2 0 0 0 0 0 0 0 0 \
@@ -120,7 +120,7 @@ In this example Rate Limiting is enabled for Host port TX channels and External
120120
* pri6 traffic mapped to TC1, External Ports FIFO1, cir=200Mbit, eir=250Mbit
121121
* pri0-5 traffic mapped to TC1, External Ports FIFO0
122122

123-
::
123+
.. code:: console
124124
125125
ip link set dev eth0 down
126126
ethtool -L eth0 tx 8
@@ -181,7 +181,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.
181181

182182
1. Create and run the following script on AM625-SK:
183183

184-
::
184+
.. code:: console
185185
186186
#!/bin/sh
187187
@@ -207,7 +207,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.
207207
In the above script, the tx queues that send data to the host port are rate-
208208
limited using the following commands:
209209

210-
::
210+
.. code:: console
211211
212212
# Rate limit tx queue 7 of eth0 to 106 Mbps
213213
echo 106 > /sys/class/net/eth0/queues/tx-7/tx_maxrate
@@ -216,21 +216,21 @@ limited using the following commands:
216216
217217
2. Next, assign IP address of 192.168.1.2 to Port-1 of the CPSW5G ports on J7VCL using:
218218

219-
::
219+
.. code:: console
220220
221221
ifconfig eth1 192.168.1.2
222222
223223
3. Next, start an iperf server on J7VCL by running:
224224

225-
::
225+
.. code:: console
226226
227227
iperf3 -s -p 5001&
228228
iperf3 -s -p 5002&
229229
iperf3 -s -p 5003&
230230
231231
4. Now, run the iperf client on AM625-SK using:
232232

233-
::
233+
.. code:: console
234234
235235
iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
236236
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
@@ -240,7 +240,7 @@ limited using the following commands:
240240

241241
On AM625-SK:
242242

243-
::
243+
.. code:: console
244244
245245
pri0: - - - - - - - - - - - - - - - - - - - - - - - - -
246246
pri0: [ ID] Interval Transfer Bitrate Retr
@@ -270,7 +270,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.
270270

271271
1. Create and run the following script on J7VCL:
272272

273-
::
273+
.. code:: bash
274274
275275
#!/bin/sh
276276
@@ -298,7 +298,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.
298298
In the above script, the tx queues that send data to the host port are rate-
299299
limited using the following commands:
300300

301-
::
301+
.. code:: console
302302
303303
# Rate limit tx queue 7 of eth0 to 106 Mbps
304304
echo 106 > /sys/class/net/eth0/queues/tx-7/tx_maxrate
@@ -307,21 +307,21 @@ limited using the following commands:
307307
308308
2. Next, assign IP address of 192.168.1.2 to Port-1 of the CPSW3G ports on AM625-SK using:
309309

310-
::
310+
.. code:: console
311311
312312
ifconfig eth0 192.168.1.2
313313
314314
3. Next, start an iperf server on AM625-SK by running:
315315

316-
::
316+
.. code:: console
317317
318318
iperf3 -s -p 5001&
319319
iperf3 -s -p 5002&
320320
iperf3 -s -p 5003&
321321
322322
4. Now, run the iperf client on J7VCL using:
323323

324-
::
324+
.. code:: console
325325
326326
iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
327327
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
@@ -331,7 +331,7 @@ limited using the following commands:
331331

332332
On J7VCL:
333333

334-
::
334+
.. code:: console
335335
336336
pri0: - - - - - - - - - - - - - - - - - - - - - - - - -
337337
pri0: [ ID] Interval Transfer Bitrate Retr
@@ -361,7 +361,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.
361361

362362
1. Create and run the following script on AM625-SK:
363363

364-
::
364+
.. code:: sh
365365
366366
#!/bin/sh
367367
@@ -388,21 +388,21 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.
388388
389389
2. Assign IP address of 192.168.1.2 to Port-1 of the CPSW5G ports on J7VCL using:
390390

391-
::
391+
.. code:: console
392392
393393
ifconfig eth1 192.168.1.2
394394
395395
3. Next, start an iperf server on J7VCL using:
396396

397-
::
397+
.. code:: console
398398
399399
iperf3 -s -p 5001&
400400
iperf3 -s -p 5002&
401401
iperf3 -s -p 5003&
402402
403403
4. Now, run the iperf client on AM625-SK using:
404404

405-
::
405+
.. code:: console
406406
407407
iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
408408
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
@@ -412,7 +412,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.
412412

413413
On AM625-SK:
414414

415-
::
415+
.. code:: console
416416
417417
pri7: - - - - - - - - - - - - - - - - - - - - - - - - -
418418
pri7: [ ID] Interval Transfer Bitrate Retr
@@ -442,7 +442,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.
442442

443443
1. Create and run the following script on J7VCL:
444444

445-
::
445+
.. code:: sh
446446
447447
#!/bin/sh
448448
@@ -471,21 +471,21 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.
471471
472472
2. Assign IP address of 192.168.1.2 to Port-1 of the CPSW3G ports on AM625-SK using:
473473

474-
::
474+
.. code:: console
475475
476476
ifconfig eth0 192.168.1.2
477477
478478
3. Next, start an iperf server on AM625-SK using:
479479

480-
::
480+
.. code:: console
481481
482482
iperf3 -s -p 5001&
483483
iperf3 -s -p 5002&
484484
iperf3 -s -p 5003&
485485
486486
4. Now, run the iperf client on J7VCL using:
487487

488-
::
488+
.. code:: console
489489
490490
iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
491491
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
@@ -495,7 +495,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.
495495

496496
On J7VCL:
497497

498-
::
498+
.. code:: console
499499
500500
pri0: - - - - - - - - - - - - - - - - - - - - - - - - -
501501
pri0: [ ID] Interval Transfer Bitrate Retr
@@ -540,7 +540,7 @@ eth1.
540540

541541
1. Create and run the following script on AM625-SK:
542542

543-
::
543+
.. code:: sh
544544
545545
#!/bin/sh
546546
ifconfig eth0 down
@@ -572,7 +572,7 @@ eth1.
572572
573573
2. Create and run the following script on AM64-SK:
574574

575-
::
575+
.. code:: sh
576576
577577
#!/bin/sh
578578
@@ -603,7 +603,7 @@ eth1.
603603
604604
3. Create and run the following scripts on J7VCL:
605605

606-
::
606+
.. code:: console
607607
608608
#!/bin/sh
609609
@@ -617,15 +617,15 @@ eth1.
617617
618618
4. Now, run the iperf client on AM64-SK using the following commands:
619619

620-
::
620+
.. code:: console
621621
622622
iperf3 -c 192.168.1.2 -u -b108M -t10 -p5001 -Tpri7 & \
623623
iperf3 -c 192.168.1.2 -u -b214M -t10 -p5002 -Tpri6 & \
624624
iperf3 -c 192.168.1.2 -u -b102M -t10 -p5003 -Tpri0
625625
626626
**Results:**
627627

628-
::
628+
.. code:: console
629629
630630
pri7: - - - - - - - - - - - - - - - - - - - - - - - - -
631631
pri7: [ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams
@@ -655,7 +655,7 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.
655655

656656
1. Create and run the following script on J7VCL:
657657

658-
::
658+
.. code:: console
659659
660660
#!/bin/sh
661661
ifconfig eth1 down
@@ -689,7 +689,7 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.
689689
690690
2. Create and run the following script on AM64-SK:
691691

692-
::
692+
.. code:: console
693693
694694
#!/bin/sh
695695
@@ -720,7 +720,7 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.
720720
721721
3. Create and run the following script on AM625-SK:
722722

723-
::
723+
.. code:: console
724724
725725
#!/bin/sh
726726
@@ -734,15 +734,15 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.
734734
735735
4. Now, run the iperf client on AM64-SK using the following commands:
736736

737-
::
737+
.. code:: console
738738
739739
iperf3 -c 192.168.1.2 -u -b108M -t10 -p5001 -Tpri7 & \
740740
iperf3 -c 192.168.1.2 -u -b214M -t10 -p5002 -Tpri6 & \
741741
iperf3 -c 192.168.1.2 -u -b102M -t10 -p5003 -Tpri0
742742
743743
**Results:**
744744

745-
::
745+
.. code:: console
746746
747747
pri6: - - - - - - - - - - - - - - - - - - - - - - - - -
748748
pri6: [ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams

0 commit comments

Comments
 (0)