Skip to content

fix(CPSW): Update the CPSW documenation with Sphinx compatibility #410

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
chintan013 wants to merge 1 commit into from
Closed

fix(CPSW): Update the CPSW documenation with Sphinx compatibility #410

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/CPSW-CBS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Host port ingress Rate Limiting offload
The netdev sysfs **tx_maxrate** parameter can be used to configure rate limit in Mbit/s per TX DMA channel.
The rate for shapers has to be set a little bit more then potential incoming rate, and real rates can differ, due to discreetness.

::
.. code:: console

echo 100 > /sys/class/net/eth2/queues/tx-7/tx_maxrate

Expand All @@ -40,7 +40,7 @@ In this example Rate Limiting is enabled only for Host port TX channels.
* pri6 traffic routed to TX DMA channel 6, rate limit 200Mbit
* pri0-5 traffic routed to TX DMA channel 0

::
.. code:: console

ip link set dev eth0 down
ethtool -L eth0 tx 8
Expand Down Expand Up @@ -100,7 +100,7 @@ The MQPRIO Qdisc **shaper bw_rlimit min_rate and max_rate** parameters can be us
* 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
* the rate for shapers has to be set a little bit more then potential incoming rate, and real rates can differ, due to discreetness.

::
.. code:: console

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

::
.. code:: console

ip link set dev eth0 down
ethtool -L eth0 tx 8
Expand Down Expand Up @@ -181,7 +181,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.

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

::
.. code:: console

#!/bin/sh

@jeevantelukula jeevantelukula Jul 28, 2025

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#!/bin/sh
#!/bin/sh

I see many references in this PR with improper indentation. Make sure to maintain the indentation of 3 spaces here.
Refer: https://github.com/TexasInstruments/processor-sdk-doc/blob/master/CONTRIBUTING.md#indentation-and-whitespace


Expand All @@ -207,7 +207,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.
In the above script, the tx queues that send data to the host port are rate-
limited using the following commands:

::
.. code:: console

# Rate limit tx queue 7 of eth0 to 106 Mbps
echo 106 > /sys/class/net/eth0/queues/tx-7/tx_maxrate
Expand All @@ -216,21 +216,21 @@ limited using the following commands:

2. Next, assign IP address of 192.168.1.2 to Port-1 of the CPSW5G ports on J7VCL using:

::
.. code:: console

ifconfig eth1 192.168.1.2

3. Next, start an iperf server on J7VCL by running:

::
.. code:: console

iperf3 -s -p 5001&
iperf3 -s -p 5002&
iperf3 -s -p 5003&

4. Now, run the iperf client on AM625-SK using:

::
.. code:: console

iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
Expand All @@ -240,7 +240,7 @@ limited using the following commands:

On AM625-SK:

::
.. code:: console

pri0: - - - - - - - - - - - - - - - - - - - - - - - - -
pri0: [ ID] Interval Transfer Bitrate Retr
Expand Down Expand Up @@ -270,7 +270,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.

1. Create and run the following script on J7VCL:

::
.. code:: bash

#!/bin/sh

Expand Down Expand Up @@ -298,7 +298,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.
In the above script, the tx queues that send data to the host port are rate-
limited using the following commands:

::
.. code:: console

# Rate limit tx queue 7 of eth0 to 106 Mbps
echo 106 > /sys/class/net/eth0/queues/tx-7/tx_maxrate
Expand All @@ -307,21 +307,21 @@ limited using the following commands:

2. Next, assign IP address of 192.168.1.2 to Port-1 of the CPSW3G ports on AM625-SK using:

::
.. code:: console

ifconfig eth0 192.168.1.2

3. Next, start an iperf server on AM625-SK by running:

::
.. code:: console

iperf3 -s -p 5001&
iperf3 -s -p 5002&
iperf3 -s -p 5003&

4. Now, run the iperf client on J7VCL using:

::
.. code:: console

iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
Expand All @@ -331,7 +331,7 @@ limited using the following commands:

On J7VCL:

::
.. code:: console

pri0: - - - - - - - - - - - - - - - - - - - - - - - - -
pri0: [ ID] Interval Transfer Bitrate Retr
Expand Down Expand Up @@ -361,7 +361,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.

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

::
.. code:: sh

#!/bin/sh

Expand All @@ -388,21 +388,21 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.

2. Assign IP address of 192.168.1.2 to Port-1 of the CPSW5G ports on J7VCL using:

::
.. code:: console

ifconfig eth1 192.168.1.2

3. Next, start an iperf server on J7VCL using:

::
.. code:: console

iperf3 -s -p 5001&
iperf3 -s -p 5002&
iperf3 -s -p 5003&

4. Now, run the iperf client on AM625-SK using:

::
.. code:: console

iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
Expand All @@ -412,7 +412,7 @@ Connect eth0 of AM625-SK to eth1 of J7VCL.

On AM625-SK:

::
.. code:: console

pri7: - - - - - - - - - - - - - - - - - - - - - - - - -
pri7: [ ID] Interval Transfer Bitrate Retr
Expand Down Expand Up @@ -442,7 +442,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.

1. Create and run the following script on J7VCL:

::
.. code:: sh

#!/bin/sh

Expand Down Expand Up @@ -471,21 +471,21 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.

2. Assign IP address of 192.168.1.2 to Port-1 of the CPSW3G ports on AM625-SK using:

::
.. code:: console

ifconfig eth0 192.168.1.2

3. Next, start an iperf server on AM625-SK using:

::
.. code:: console

iperf3 -s -p 5001&
iperf3 -s -p 5002&
iperf3 -s -p 5003&

4. Now, run the iperf client on J7VCL using:

::
.. code:: console

iperf3 -c 192.168.1.2 -t10 -p5001 -Tpri7 & \
iperf3 -c 192.168.1.2 -t10 -p5002 -Tpri6 & \
Expand All @@ -495,7 +495,7 @@ Connect eth1 of J7VCL to eth0 of AM625-SK.

On J7VCL:

::
.. code:: console

pri0: - - - - - - - - - - - - - - - - - - - - - - - - -
pri0: [ ID] Interval Transfer Bitrate Retr
Expand Down Expand Up @@ -540,7 +540,7 @@ eth1.

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

::
.. code:: sh

#!/bin/sh
ifconfig eth0 down
Expand Down Expand Up @@ -572,7 +572,7 @@ eth1.

2. Create and run the following script on AM64-SK:

::
.. code:: sh

#!/bin/sh

Expand Down Expand Up @@ -603,7 +603,7 @@ eth1.

3. Create and run the following scripts on J7VCL:

::
.. code:: console

@StaticRocket StaticRocket Jul 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. code:: console
.. code:: sh


#!/bin/sh

Expand All @@ -617,15 +617,15 @@ eth1.

4. Now, run the iperf client on AM64-SK using the following commands:

::
.. code:: console

iperf3 -c 192.168.1.2 -u -b108M -t10 -p5001 -Tpri7 & \
iperf3 -c 192.168.1.2 -u -b214M -t10 -p5002 -Tpri6 & \
iperf3 -c 192.168.1.2 -u -b102M -t10 -p5003 -Tpri0

**Results:**

::
.. code:: console

pri7: - - - - - - - - - - - - - - - - - - - - - - - - -
pri7: [ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams
Expand Down Expand Up @@ -655,7 +655,7 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.

1. Create and run the following script on J7VCL:

::
.. code:: console

@StaticRocket StaticRocket Jul 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. code:: console
.. code:: sh


#!/bin/sh
ifconfig eth1 down
Expand Down Expand Up @@ -689,7 +689,7 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.

2. Create and run the following script on AM64-SK:

::
.. code:: console

@StaticRocket StaticRocket Jul 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. code:: console
.. code:: sh


#!/bin/sh

Expand Down Expand Up @@ -720,7 +720,7 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.

3. Create and run the following script on AM625-SK:

::
.. code:: console

@StaticRocket StaticRocket Jul 30, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. code:: console
.. code:: sh


#!/bin/sh

Expand All @@ -734,15 +734,15 @@ Connect AM64-SK's eth0 to J7VCL's eth1 and AM625-SK's eth0 to J7VCL's eth2.

4. Now, run the iperf client on AM64-SK using the following commands:

::
.. code:: console

iperf3 -c 192.168.1.2 -u -b108M -t10 -p5001 -Tpri7 & \
iperf3 -c 192.168.1.2 -u -b214M -t10 -p5002 -Tpri6 & \
iperf3 -c 192.168.1.2 -u -b102M -t10 -p5003 -Tpri0

**Results:**

::
.. code:: console

pri6: - - - - - - - - - - - - - - - - - - - - - - - - -
pri6: [ ID] Interval Transfer Bitrate Jitter Lost/Total Datagrams
Expand Down
Loading