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
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]>
Copy file name to clipboardExpand all lines: source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst
+69-72Lines changed: 69 additions & 72 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,6 @@ Supported platforms
29
29
30
30
.. include:: AM65X_PRU_ICSSG_boards.rst
31
31
32
-
33
32
Features supported
34
33
##################
35
34
@@ -63,7 +62,7 @@ Driver Configuration
63
62
The TI Processor SDK has ICSSG driver enabled by default on supported platforms.
64
63
In case of custom builds, please ensure following configs are enabled.
65
64
66
-
::
65
+
.. code-block:: console
67
66
68
67
CONFIG_TI_PRUSS
69
68
CONFIG_REMOTEPROC
@@ -94,7 +93,7 @@ Bringing Up interface
94
93
95
94
The network interface can be configured automatically depending on root file system or configured manually. Manual configuration:
96
95
97
-
::
96
+
.. code-block:: console
98
97
99
98
ip addr add 192.168.1.1/24 dev eth1
100
99
ip link set dev eth1 up
@@ -103,8 +102,6 @@ The network interface can be configured automatically depending on root file sys
103
102
104
103
ifconfig eth1 <ip> netmask <mask> up
105
104
106
-
|
107
-
108
105
Get information (ethtool)
109
106
*************************
110
107
@@ -114,62 +111,62 @@ Get driver information
114
111
The interface can be identified by using ``ethtool -i|--driver DEVNAME`` command.
115
112
It also provides some information about supported features.
116
113
117
-
::
114
+
.. code-block:: console
118
115
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
130
127
131
128
Display standard information about device/link
132
129
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
133
130
134
131
Run ``ethtool DEVNAME`` command without parameters.
135
132
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
166
163
167
164
Display time stamping capabilities
168
165
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
169
166
170
167
The interface time stamping capabilities can be retrieved by using ``ethtool -T|--show-time-stamping DEVNAME`` command.
171
168
172
-
::
169
+
.. code-block:: console
173
170
174
171
ethtool -T eth2
175
172
Time stamping parameters for eth2:
@@ -193,7 +190,7 @@ Show permanent hardware address
193
190
194
191
The interface permanent hardware address can be retrieved by using ``ethtool -P|--show-permaddr DEVNAME`` command.
195
192
196
-
::
193
+
.. code-block:: console
197
194
198
195
~# ethtool -P eth1
199
196
Permanent address: 70:ff:76:1d:5c:64
@@ -203,7 +200,7 @@ Query Channels information
203
200
204
201
The interface DMA Channels information can be retrieved by using ``ethtool-l|--show-channels DEVNAME`` command.
205
202
206
-
::
203
+
.. code-block:: console
207
204
208
205
# ethtool -l eth1
209
206
Channel parameters for eth1:
@@ -226,7 +223,7 @@ The interface statistics are divided into several parts. Different statistics ca
226
223
Standard Netdev Staticstics
227
224
"""""""""""""""""""""""""""
228
225
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>`__
230
227
231
228
.. code-block:: console
232
229
@@ -245,7 +242,7 @@ Standard netdev staticstics such as RX / TX bytes / packet count can be retrieve
245
242
Protocol-specific statistics
246
243
""""""""""""""""""""""""""""
247
244
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>`__
249
246
250
247
.. code-block:: console
251
248
@@ -333,7 +330,7 @@ Show EEE settings
333
330
334
331
The interface EEE settings can be retrieved by using ``ethtool --show-eee DEVNAME`` command.
335
332
336
-
::
333
+
.. code-block:: console
337
334
338
335
ethtool --show-eee eth1
339
336
EEE Settings for eth1:
@@ -354,7 +351,7 @@ VLAN can be added/deleted using ``ip`` or ``vconfig`` utility.
354
351
355
352
*VLAN Add*
356
353
357
-
::
354
+
.. code-block:: console
358
355
359
356
ip link add link eth1 name eth1.5 type vlan id 5
360
357
@@ -364,7 +361,7 @@ VLAN can be added/deleted using ``ip`` or ``vconfig`` utility.
364
361
365
362
*VLAN del*
366
363
367
-
::
364
+
.. code-block:: console
368
365
369
366
ip link del eth1.5
370
367
@@ -381,7 +378,7 @@ using ``ip`` or ``ifconfig``.
381
378
Once VLAN is added, it will create a new entry in Ethernet interfaces
382
379
like eth1.5, below is an example how it check the vlan interface
383
380
384
-
::
381
+
.. code-block:: console
385
382
386
383
ip addr add 10.0.0.5/24 dev eth1.5
387
384
@@ -413,7 +410,7 @@ Interrupt pacing
413
410
414
411
The Interrupt pacing (IRQ coalescing) based on hrtimers for RX / TX data path separately can be enabled by ethtool commands (min value is 20us):
415
412
416
-
::
413
+
.. code-block:: console
417
414
418
415
ethtool -C ethX rx-usecs N # Enable RX coalescing
419
416
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
423
420
424
421
The Interrupt pacing (IRQ coalescing) configuration can be retrieved by commands:
425
422
426
-
::
423
+
.. code-block:: console
427
424
428
425
ethtool -c ethX # Show RX coalescing and TX coalescing for TX0
429
426
ethtool -Q ethX queue_mask 1 --show-coalesce # Show coalescing configuration for TX0
0 commit comments