Skip to content

Feature/extlinks #382

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

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Feature/extlinks #382

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca648ea
feat(extlinks): add extlinks and a suitable config
StaticRocket Jul 15, 2025
f8e2624
feat(extlinks): use ti-linux-kernel-binding role
StaticRocket Jul 15, 2025
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
6 changes: 6 additions & 0 deletions conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import sys
import os
import importlib
import json
from datetime import datetime

# If extensions (or modules to document with autodoc) are in another directory,
Expand All @@ -36,6 +37,7 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.extlinks',
'sphinx.ext.intersphinx',
'sphinx.ext.todo',
'sphinx.ext.mathjax',
Expand Down Expand Up @@ -258,6 +260,10 @@
# Suppress warnings about excluded documents because every device gets a different toc tree
suppress_warnings = ['toc.excluded']

# Load extlinks config
with open(os.path.join(rootdir, 'extlinks.json'), 'r', encoding='utf-8') as extconf:
extlinks = json.load(extconf)

# -- Tag file loader ------------------------------------------------------

FAMILY = os.environ.get("DEVFAMILY", "")
Expand Down
6 changes: 6 additions & 0 deletions extlinks.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"ti-linux-kernel-binding": [
"https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/%s?h=ti-linux-6.12.y",
"Documentation/devicetree/bindings/%s"
]
}
2 changes: 1 addition & 1 deletion source/linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ Note: this is not a comprehensive list of features supported/not supported, and
.. ifconfig:: CONFIG_part_variant in ('AM62PX', 'J722S')

More detailed description of these properties can be found at:
`Display device-tree file <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/display/ti/ti,am65x-dss.yaml?h=09.01.00.008>`__
:ti-linux-kernel-binding:`Display device-tree file <display/ti/ti,am65x-dss.yaml`
Also there is a how-to guide available for dss sharing which walks through different examples for resource paritioning using these device-tree properties :
`How to enable dss sharing between remote core and Linux <../../../../How_to_Guides/Target/How_to_enable_display_sharing_between_remotecore_and_Linux.html>`__

Expand Down
5 changes: 2 additions & 3 deletions source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,8 @@ Device tree bindings

The DT bindings description can be found at:

| `Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/net/ti,icssg-prueth.yaml?h=ti-linux-6.6.y>`__
| `Documentation/devicetree/bindings/net/ti,davinci-mdio.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/net/ti,davinci-mdio.yaml?h=ti-linux-6.6.y>`__
|
:ti-linux-kernel-binding:`net/ti,icssg-prueth.yaml`
:ti-linux-kernel-binding:`net/ti,davinci-mdio.yaml`

User guide
##########
Expand Down
3 changes: 1 addition & 2 deletions ...inux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,8 +68,7 @@

The DT bindings description can be found at:

| `Documentation/devicetree/bindings/net/ti,icssg-prueth.txt <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/net/ti,icssg-prueth.txt?h=ti-linux-5.10.y>`__
|
:ti-linux-kernel-binding:`net/ti,icssg-prueth.txt`

Check warning on line 71 in source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'net/ti'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'net/ti'", "location": {"path": "source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst", "range": {"start": {"line": 71, "column": 27}}}, "severity": "WARNING"}

Check warning on line 71 in source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.", "location": {"path": "source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_sr10.rst", "range": {"start": {"line": 71, "column": 5}}}, "severity": "WARNING"}

User guide
##########
Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC62ax.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,8 @@
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.12.y>`__
See the devicetree bindings documentation for more details:

Check warning on line 167 in source/linux/Foundational_Components_IPC62ax.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'devicetree'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'devicetree'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components_IPC62ax.rst", "range": {"start": {"line": 167, "column": 9}}}, "severity": "WARNING"}
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

Check warning on line 168 in source/linux/Foundational_Components_IPC62ax.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'remoteproc/ti'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'remoteproc/ti'", "location": {"path": "source/linux/Foundational_Components_IPC62ax.rst", "range": {"start": {"line": 168, "column": 27}}}, "severity": "WARNING"}

Check warning on line 168 in source/linux/Foundational_Components_IPC62ax.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.", "location": {"path": "source/linux/Foundational_Components_IPC62ax.rst", "range": {"start": {"line": 168, "column": 5}}}, "severity": "WARNING"}

::

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC62px.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,8 @@
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:

Check warning on line 158 in source/linux/Foundational_Components_IPC62px.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'devicetree'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'devicetree'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components_IPC62px.rst", "range": {"start": {"line": 158, "column": 9}}}, "severity": "WARNING"}
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

Check warning on line 159 in source/linux/Foundational_Components_IPC62px.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'remoteproc/ti'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'remoteproc/ti'", "location": {"path": "source/linux/Foundational_Components_IPC62px.rst", "range": {"start": {"line": 159, "column": 27}}}, "severity": "WARNING"}

+------------------+--------------------+---------+----------------------------+
| Memory Section | Physical Address | Size | Description |
Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC62x.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.12.y>`__
See the devicetree bindings documentation for more details:

Check warning on line 161 in source/linux/Foundational_Components_IPC62x.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Spelling] Verify the word 'devicetree'. It is not in the American English spelling dictionary used by Vale.

Raw Output:
{"message": "[RedHat.Spelling] Verify the word 'devicetree'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "source/linux/Foundational_Components_IPC62x.rst", "range": {"start": {"line": 161, "column": 9}}}, "severity": "WARNING"}
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

Check warning on line 162 in source/linux/Foundational_Components_IPC62x.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.Slash] Use either 'or' or 'and' in 'remoteproc/ti'

Raw Output:
{"message": "[RedHat.Slash] Use either 'or' or 'and' in 'remoteproc/ti'", "location": {"path": "source/linux/Foundational_Components_IPC62x.rst", "range": {"start": {"line": 162, "column": 27}}}, "severity": "WARNING"}

Check warning on line 162 in source/linux/Foundational_Components_IPC62x.rst

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.

Raw Output:
{"message": "[RedHat.CaseSensitiveTerms] Use 'Linux' rather than 'linux'.", "location": {"path": "source/linux/Foundational_Components_IPC62x.rst", "range": {"start": {"line": 162, "column": 5}}}, "severity": "WARNING"}

+------------------+--------------------+---------+----------------------------+
| Memory Section | Physical Address | Size | Description |
Expand Down
2 changes: 1 addition & 1 deletion source/linux/Foundational_Components_IPC64x.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ R5F subsystems are operating in Split mode. If an R5F subsystem is run in
Single-CPU mode, then R5F Core0 continues to use memory carveouts. However,
R5F Core1 is unused in Single-CPU mode, so the Core1 memory carveouts can be
reallocated to other cores. See the devicetree bindings documentation for more
details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-5.10.y>`__
details: :ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

::

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC_J7200.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,8 @@ System memory is carved out for each remote processor core for IPC and for the
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

.. code-block:: text

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC_J721E.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,8 @@ System memory is carved out for each remote processor core for IPC and for the
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

.. code-block:: text

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC_J721S2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,8 @@ System memory is carved out for each remote processor core for IPC and for the
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

.. code-block:: text

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC_J722S.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,8 @@ System memory is carved out for each remote processor core for IPC and for the
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

.. code-block:: text

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC_J742S2.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,8 @@ System memory is carved out for each remote processor core for IPC and for the
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

.. code-block:: text

Expand Down
3 changes: 2 additions & 1 deletion source/linux/Foundational_Components_IPC_J784S4.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,8 @@ System memory is carved out for each remote processor core for IPC and for the
remote processor's code/data section needs. The default
memory carveouts (DMA pools) are shown below.

See the devicetree bindings documentation for more details: `Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml <https://git.ti.com/cgit/ti-linux-kernel/ti-linux-kernel/tree/Documentation/devicetree/bindings/remoteproc/ti,k3-r5f-rproc.yaml?h=ti-linux-6.6.y>`__
See the devicetree bindings documentation for more details:
:ti-linux-kernel-binding:`remoteproc/ti,k3-r5f-rproc.yaml`

.. code-block:: text

Expand Down
Loading