Skip to content

Commit ce1e2fc

Browse files
committed
fix(PRU-ICSS): Convert literal blocks to code-blocks
This patch updates the PRU_ICSSG_Ethernet.rst and PRU_ICSSG_Ethernet_Switch.rst documentation files to improve Sphinx compatibility and readability. The following changes are made: - Replaces all occurrences of "::" used for literal/code blocks with ".. code-block:: console" and ensures proper indentation for code examples and command-line snippets. - Updates all code and command output blocks to use the correct Sphinx directive, which enables syntax highlighting and consistent formatting in generated documentation. - Fixes minor typos in comments and documentation text, such as correcting "Fore more details" to "For more details" and improving clarity. - Ensures consistent formatting of code blocks, command outputs, and configuration examples throughout the documentation. - No functional or content changes are made to the technical information; all updates are limited to documentation formatting and style. Signed-off-by: MD Danish Anwar <[email protected]>
1 parent ef80ade commit ce1e2fc

File tree

2 files changed

+73
-76
lines changed

2 files changed

+73
-76
lines changed

source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst

Lines changed: 69 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ Supported platforms
2929

3030
.. include:: AM65X_PRU_ICSSG_boards.rst
3131

32-
3332
Features supported
3433
##################
3534

@@ -63,7 +62,7 @@ Driver Configuration
6362
The TI Processor SDK has ICSSG driver enabled by default on supported platforms.
6463
In case of custom builds, please ensure following configs are enabled.
6564

66-
::
65+
.. code-block:: console
6766
6867
CONFIG_TI_PRUSS
6968
CONFIG_REMOTEPROC
@@ -94,7 +93,7 @@ Bringing Up interface
9493

9594
The network interface can be configured automatically depending on root file system or configured manually. Manual configuration:
9695

97-
::
96+
.. code-block:: console
9897
9998
ip addr add 192.168.1.1/24 dev eth1
10099
ip link set dev eth1 up
@@ -103,8 +102,6 @@ The network interface can be configured automatically depending on root file sys
103102
104103
ifconfig eth1 <ip> netmask <mask> up
105104
106-
|
107-
108105
Get information (ethtool)
109106
*************************
110107

@@ -114,62 +111,62 @@ Get driver information
114111
The interface can be identified by using ``ethtool -i|--driver DEVNAME`` command.
115112
It also provides some information about supported features.
116113

117-
::
114+
.. code-block:: console
118115
119-
~# ethtool -i eth1
120-
driver: icssg-prueth
121-
version:
122-
firmware-version:
123-
expansion-rom-version:
124-
bus-info: pruss2_eth
125-
supports-statistics: yes
126-
supports-test: no
127-
supports-eeprom-access: no
128-
supports-register-dump: no
129-
supports-priv-flags: no
116+
~# ethtool -i eth1
117+
driver: icssg-prueth
118+
version:
119+
firmware-version:
120+
expansion-rom-version:
121+
bus-info: pruss2_eth
122+
supports-statistics: yes
123+
supports-test: no
124+
supports-eeprom-access: no
125+
supports-register-dump: no
126+
supports-priv-flags: no
130127
131128
Display standard information about device/link
132129
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
133130

134131
Run ``ethtool DEVNAME`` command without parameters.
135132

136-
::
137-
138-
~# ethtool eth1
139-
Settings for eth1:
140-
Supported ports: [ TP MII ]
141-
Supported link modes: 100baseT/Full
142-
1000baseT/Full
143-
Supported pause frame use: No
144-
Supports auto-negotiation: Yes
145-
Supported FEC modes: Not reported
146-
Advertised link modes: 100baseT/Full
147-
1000baseT/Full
148-
Advertised pause frame use: No
149-
Advertised auto-negotiation: Yes
150-
Advertised FEC modes: Not reported
151-
Link partner advertised link modes: 10baseT/Half 10baseT/Full
152-
100baseT/Half 100baseT/Full
153-
1000baseT/Full
154-
Link partner advertised pause frame use: Symmetric Receive-only
155-
Link partner advertised auto-negotiation: Yes
156-
Link partner advertised FEC modes: Not reported
157-
Speed: 1000Mb/s
158-
Duplex: Full
159-
Port: MII
160-
PHYAD: 0
161-
Transceiver: internal
162-
Auto-negotiation: on
163-
Current message level: 0x00007fff (32767)
164-
drv probe link timer ifdown ifup rx_err tx_err tx_queued intr tx_done rx_status pktdata hw wol
165-
Link detected: yes
133+
.. code-block:: console
134+
135+
~# ethtool eth1
136+
Settings for eth1:
137+
Supported ports: [ TP MII ]
138+
Supported link modes: 100baseT/Full
139+
1000baseT/Full
140+
Supported pause frame use: No
141+
Supports auto-negotiation: Yes
142+
Supported FEC modes: Not reported
143+
Advertised link modes: 100baseT/Full
144+
1000baseT/Full
145+
Advertised pause frame use: No
146+
Advertised auto-negotiation: Yes
147+
Advertised FEC modes: Not reported
148+
Link partner advertised link modes: 10baseT/Half 10baseT/Full
149+
100baseT/Half 100baseT/Full
150+
1000baseT/Full
151+
Link partner advertised pause frame use: Symmetric Receive-only
152+
Link partner advertised auto-negotiation: Yes
153+
Link partner advertised FEC modes: Not reported
154+
Speed: 1000Mb/s
155+
Duplex: Full
156+
Port: MII
157+
PHYAD: 0
158+
Transceiver: internal
159+
Auto-negotiation: on
160+
Current message level: 0x00007fff (32767)
161+
drv probe link timer ifdown ifup rx_err tx_err tx_queued intr tx_done rx_status pktdata hw wol
162+
Link detected: yes
166163
167164
Display time stamping capabilities
168165
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169166

170167
The interface time stamping capabilities can be retrieved by using ``ethtool -T|--show-time-stamping DEVNAME`` command.
171168

172-
::
169+
.. code-block:: console
173170
174171
ethtool -T eth2
175172
Time stamping parameters for eth2:
@@ -193,7 +190,7 @@ Show permanent hardware address
193190

194191
The interface permanent hardware address can be retrieved by using ``ethtool -P|--show-permaddr DEVNAME`` command.
195192

196-
::
193+
.. code-block:: console
197194
198195
~# ethtool -P eth1
199196
Permanent address: 70:ff:76:1d:5c:64
@@ -203,7 +200,7 @@ Query Channels information
203200

204201
The interface DMA Channels information can be retrieved by using ``ethtool-l|--show-channels DEVNAME`` command.
205202

206-
::
203+
.. code-block:: console
207204
208205
# ethtool -l eth1
209206
Channel parameters for eth1:
@@ -226,7 +223,7 @@ The interface statistics are divided into several parts. Different statistics ca
226223
Standard Netdev Staticstics
227224
"""""""""""""""""""""""""""
228225

229-
Standard netdev staticstics such as RX / TX bytes / packet count can be retrieved using the command ``ip -s -s link show dev DEVNAME``. Fore more details refer `Standard interface statistics <https://docs.kernel.org/networking/statistics.html#standard-interface-statistics>`__
226+
Standard netdev staticstics such as RX / TX bytes / packet count can be retrieved using the command ``ip -s -s link show dev DEVNAME``. For more details refer `Standard interface statistics <https://docs.kernel.org/networking/statistics.html#standard-interface-statistics>`__
230227

231228
.. code-block:: console
232229
@@ -245,7 +242,7 @@ Standard netdev staticstics such as RX / TX bytes / packet count can be retrieve
245242
Protocol-specific statistics
246243
""""""""""""""""""""""""""""
247244

248-
Protocol specific staticstics such as packet counts for different octet sizes can be retrieved using the command ``ethtool -S DEVNAME --groups rmon``. Fore more details refer `Protocol specific statistics <https://docs.kernel.org/networking/statistics.html#protocol-specific-statistics>`__
245+
Protocol specific staticstics such as packet counts for different octet sizes can be retrieved using the command ``ethtool -S DEVNAME --groups rmon``. For more details refer `Protocol specific statistics <https://docs.kernel.org/networking/statistics.html#protocol-specific-statistics>`__
249246

250247
.. code-block:: console
251248
@@ -333,7 +330,7 @@ Show EEE settings
333330

334331
The interface EEE settings can be retrieved by using ``ethtool --show-eee DEVNAME`` command.
335332

336-
::
333+
.. code-block:: console
337334
338335
ethtool --show-eee eth1
339336
EEE Settings for eth1:
@@ -354,7 +351,7 @@ VLAN can be added/deleted using ``ip`` or ``vconfig`` utility.
354351

355352
*VLAN Add*
356353

357-
::
354+
.. code-block:: console
358355
359356
ip link add link eth1 name eth1.5 type vlan id 5
360357
@@ -364,7 +361,7 @@ VLAN can be added/deleted using ``ip`` or ``vconfig`` utility.
364361
365362
*VLAN del*
366363

367-
::
364+
.. code-block:: console
368365
369366
ip link del eth1.5
370367
@@ -381,7 +378,7 @@ using ``ip`` or ``ifconfig``.
381378
Once VLAN is added, it will create a new entry in Ethernet interfaces
382379
like eth1.5, below is an example how it check the vlan interface
383380

384-
::
381+
.. code-block:: console
385382
386383
ip addr add 10.0.0.5/24 dev eth1.5
387384
@@ -413,7 +410,7 @@ Interrupt pacing
413410

414411
The Interrupt pacing (IRQ coalescing) based on hrtimers for RX / TX data path separately can be enabled by ethtool commands (min value is 20us):
415412

416-
::
413+
.. code-block:: console
417414
418415
ethtool -C ethX rx-usecs N # Enable RX coalescing
419416
ethtool -C ethX tx-usecs N # Enable TX coalescing for TX0 by default.
@@ -423,7 +420,7 @@ The Interrupt pacing (IRQ coalescing) based on hrtimers for RX / TX data path se
423420
424421
The Interrupt pacing (IRQ coalescing) configuration can be retrieved by commands:
425422

426-
::
423+
.. code-block:: console
427424
428425
ethtool -c ethX # Show RX coalescing and TX coalescing for TX0
429426
ethtool -Q ethX queue_mask 1 --show-coalesce # Show coalescing configuration for TX0
@@ -441,7 +438,7 @@ socket ioctl SIOCADDMULTI/SIOCDELMULTI.
441438

442439
*Show muliticast address*
443440

444-
::
441+
.. code-block:: console
445442
446443
~# ip maddr show eth1
447444
3: eth1
@@ -465,7 +462,7 @@ socket ioctl SIOCADDMULTI/SIOCDELMULTI.
465462
466463
*Add muliticast address*
467464

468-
::
465+
.. code-block:: console
469466
470467
~# ip maddr add 01:00:5e:00:00:05 dev eth1
471468
~# ip maddr show dev eth1
@@ -490,7 +487,7 @@ socket ioctl SIOCADDMULTI/SIOCDELMULTI.
490487
491488
*Delete muliticast address*
492489

493-
::
490+
.. code-block:: console
494491
495492
# ip maddr del 01:00:5e:00:00:05 dev eth1
496493
@@ -526,7 +523,7 @@ the below command.
526523
Please note running a tool like tcpdump will itself enable promiscous
527524
mode.
528525

529-
::
526+
.. code-block:: console
530527
531528
ip link set eth0 promisc on
532529
@@ -541,7 +538,7 @@ The main purpose of this command is to configure physical link settings (PHY) li
541538

542539
Below commands will be redirected to the phy driver:
543540

544-
::
541+
.. code-block:: console
545542
546543
# ethtool -s <dev>
547544
[ speed %d ]
@@ -557,7 +554,7 @@ Below commands will be redirected to the phy driver:
557554

558555
Below is an example of forcing link speed to 100M and duplexity to full:
559556

560-
::
557+
.. code-block:: console
561558
562559
# ethtool -s eth1 duplex full speed 100
563560
[ 74.768324] icssg-prueth pruss2_eth eth1: Link is Down
@@ -569,7 +566,7 @@ Restart N-WAY (PHY) negotiation
569566

570567
The interface PHY auto-negotiation can be restarted by using ``ethtool -r|--negotiate DEVNAME`` command.
571568

572-
::
569+
.. code-block:: console
573570
574571
# ethtool -r eth1
575572
[ 273.151655] icssg-prueth pruss2_eth eth1: Link is Down
@@ -582,7 +579,7 @@ The interface DMA channels parameters can be set by using ``ethtool -L\|--set-ch
582579
It allows to control number of TX channels driver is allowed to work with at DMA level. The maximum number of TX channels is 4.
583580
Supported options ``[ tx N ]``:
584581

585-
::
582+
.. code-block:: console
586583
587584
# ethtool -L eth1 tx 4
588585
@@ -601,15 +598,15 @@ The IEP1 is used for Firmware purposes.
601598

602599
The PTP Ordinary Clock (OC) implementation is provided by the linuxptp application.
603600

604-
::
601+
.. code-block:: console
605602
606603
ptp4l -f oc.cfg
607604
608605
oc.cfg is a ptp4l configuration file.
609606

610607
Example oc.cfg for OC,
611608

612-
::
609+
.. code-block:: console
613610
614611
[global]
615612
tx_timestamp_timeout 10
@@ -631,7 +628,7 @@ page <https://man.cx/ptp4l>`__ about ptp4l configurations in particular.
631628
Here is a sample screen display of ptp4l for PRU-ICSS Ethernet port as
632629
PTP/OC in slave mode:
633630

634-
::
631+
.. code-block:: console
635632
636633
# ptp4l -f oc.cfg -s -m
637634
ptp4l[1255.613]: selected /dev/ptp2 as PTP clock
@@ -690,7 +687,7 @@ To find out the PTP device number i.e. PTP Hardware Clock, use ``ethtool -T DEVN
690687

691688
To turn on PPS,
692689

693-
::
690+
.. code-block:: console
694691
695692
# ip link set dev eth1 up
696693
# ./testptp -d /dev/ptp2 -P 1
@@ -706,7 +703,7 @@ To turn on PPS,
706703

707704
To turn off PPS,
708705

709-
::
706+
.. code-block:: console
710707
711708
# ./testptp -d /dev/ptp2 -P 0
712709
pps for system time request okay
@@ -781,7 +778,7 @@ To indicate that HW supports HD the DT "ti,half-duplex-capable" property shell b
781778

782779
For example:
783780

784-
::
781+
.. code-block:: console
785782
786783
icssg0_eth: icssg0-eth {
787784
...

source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_Switch.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Enabling Switch mode
1414

1515
Example assuming ETH1 and ETH2 as ICSSG0 interfaces:
1616

17-
::
17+
.. code-block:: console
1818
1919
ip link add name br0 type bridge
2020
ip link set dev eth1 master br0
@@ -25,7 +25,7 @@ Example assuming ETH1 and ETH2 as ICSSG0 interfaces:
2525
Going back to Dual EMAC mode
2626
""""""""""""""""""""""""""""
2727

28-
::
28+
.. code-block:: console
2929
3030
ip link set dev br0 down
3131
ip link set dev eth1 nomaster
@@ -35,14 +35,14 @@ Going back to Dual EMAC mode
3535
Turn On/Off Spanning Tree Protocol (STP)
3636
""""""""""""""""""""""""""""""""""""""""
3737

38-
::
38+
.. code-block:: console:
3939

4040
ip link set dev br0 type bridge stp_state 1/0
4141

4242
VLAN configuration
4343
""""""""""""""""""
4444

45-
::
45+
.. code-block:: console
4646
4747
bridge vlan add dev br0 vid 1 pvid untagged self <---- add cpu port to VLAN 1
4848

0 commit comments

Comments
 (0)