Skip to content

docs(linux): Add documentation for HSR Redbox support #796

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

Open
danish-ti wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs(linux): Add documentation for HSR Redbox support #796

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
18 changes: 18 additions & 0 deletions source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
The below script sets up an HSR interface with the port-to-port
forwarding and Tx packet duplication offloaded

.. _hsr-setup-script:
.. code-block:: bash

#!/bin/sh
Expand Down Expand Up @@ -429,3 +430,20 @@
* - 505 Mbits/sec
- 504 Mbits/sec

.. rubric:: HSR RedBox Support

Check warning on line 433 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":433,"column":13},"end":{"line":433,"column":16}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}

The HSR RedBox feature extends standard HSR functionality by adding an interlink port

Check warning on line 435 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":435,"column":41},"end":{"line":435,"column":44}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}

Check warning on line 435 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":435,"column":5},"end":{"line":435,"column":8}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}
that bridges the HSR ring to an external network segment. This allows devices on the

Check warning on line 436 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":436,"column":18},"end":{"line":436,"column":21}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}
external segment to communicate directly with HSR ring nodes as if they were part of

Check warning on line 437 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'HSR') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":437,"column":47},"end":{"line":437,"column":50}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}
the same HSR Ring.

On AM64x, ICSSG can be used as an HSR Redbox. To enable this feature, the CPSW port

Check warning on line 440 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'CPSW') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'CPSW') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":440,"column":75},"end":{"line":440,"column":79}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}

Check warning on line 440 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'Redbox'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.

Raw Output:
{"message":"[RedHat.Spelling] Verify the word 'Redbox'. It is not in the American English or Red Hat terminology spelling dictionaries used by Vale.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":440,"column":39},"end":{"line":440,"column":45}}},"severity":"WARNING","code":{"value":"RedHat.Spelling","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#spelling"}}

Check warning on line 440 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'be used' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message":"[RedHat.PassiveVoice] 'be used' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":440,"column":21},"end":{"line":440,"column":28}}},"severity":"INFO","code":{"value":"RedHat.PassiveVoice","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#passive-voice"}}

Check warning on line 440 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Definitions] Define acronyms and abbreviations (such as 'ICSSG') on first occurrence if they're likely to be unfamiliar.

Raw Output:
{"message":"[RedHat.Definitions] Define acronyms and abbreviations (such as 'ICSSG') on first occurrence if they're likely to be unfamiliar.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":440,"column":11},"end":{"line":440,"column":16}}},"severity":"INFO","code":{"value":"RedHat.Definitions","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#definitions"}}
(``eth0``) must be connected to the external network to serve as the interlink port.

Check warning on line 441 in source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.PassiveVoice] 'be connected' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.

Raw Output:
{"message":"[RedHat.PassiveVoice] 'be connected' is passive voice. In general, use active voice. Consult the style guide for acceptable use of passive voice.","location":{"path":"source/linux/Foundational_Components/Kernel/Kernel_Drivers/Network/HSR_Offload.rst","range":{"start":{"line":441,"column":17},"end":{"line":441,"column":29}}},"severity":"INFO","code":{"value":"RedHat.PassiveVoice","url":"https://redhat-documentation.github.io/vale-at-red-hat/reference-guide.html#passive-voice"}}

The existing :ref:`hsr_setup.sh script <hsr-setup-script>` can be used with small modification
to the ``ip link add`` command inside it, which must be updated as below.

.. code-block:: bash

ip link add name <HSR_INTF> type hsr slave1 <IFACE_A> slave2 <IFACE_B> interlink <INTERLINK_IFACE> supervision 45 version 1

Loading