Skip to content
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.

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

Board catalog/hw feature v2 with line numbers #64

Open
wants to merge 24 commits into
base: xx
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
24 commits
Select commit Hold shift + click to select a range
467e15d
drivers: rtc: rx8130ce: day alarm fix
Mattemagikern Feb 28, 2025
9cb0fbf
usb: device_next: fix Get Status request response
jfischer-no Feb 4, 2025
762861d
doc: Add k_pipe deprecation notice to 4.1 release notes
Mattemagikern Jan 19, 2025
05b6997
soc: amd: acp_6_0: Fix bleeding Kconfig
nordicjm Feb 27, 2025
23c195c
boards: up-bridge-the-gap: adopt new zephyr:board directive and role
kartben Feb 26, 2025
cc9c074
boards: lowrisc: adopt new zephyr:board directive and role
kartben Feb 26, 2025
b0ab5fa
boards: seagate: adopt new zephyr:board directive and role
kartben Feb 26, 2025
7654902
boards: enjoydigital: adopt new zephyr:board directive and role
kartben Feb 26, 2025
3fc5c8c
boards: cypress: adopt new zephyr:board directive and role
kartben Feb 26, 2025
98d9e51
boards: rakwireless: fix title
kartben Feb 26, 2025
8438c47
boards: ene: adopt new zephyr:board directive and role
kartben Feb 26, 2025
d1969bf
boards: ite: adopt new zephyr:board directive and role
kartben Feb 26, 2025
c0c6047
doc: develop: getting_started: Add powershell tabs
pdgendt Feb 26, 2025
3a8dddc
drivers: adc: stm32: use __maybe_unused
Feb 26, 2025
3a996c5
Bluetooth: Controller: Fix BT_CTLR_LOW_LAT_ULL dependency
cvinayak Oct 4, 2024
a7e2846
twister: setup logging per process
nashif Feb 24, 2025
a9c59d6
drivers: timer: sam0: fix MCLK pointer and mask in init function
kowalewskijan Feb 26, 2025
65d69ec
Bluetooth: Controller: Fix active mode extended scanning assert
cvinayak Feb 22, 2025
f67a94f
Bluetooth: Controller: Fix single timer end time capture
cvinayak Feb 22, 2025
23d321d
Bluetooth: Controller: Fix end time capture be on radio event end
cvinayak Feb 22, 2025
7520742
Bluetooth: Controller: Fix single timer clear event define name
cvinayak Feb 24, 2025
ec69ccb
Bluetooth: Controller: Fix single timer direction finding support
cvinayak Feb 22, 2025
8db6fa8
doc: _extensions: simplify legend creation
kartben Feb 27, 2025
4f77244
doc: extensions: Navigate to DTS entries from supported hardware list
kartben Feb 27, 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
9 changes: 1 addition & 8 deletions boards/cypress/cy8ckit_062_ble/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _cy8ckit_062_ble:

INFINEON PSOC 63 BLE Pioneer Kit
################################
.. zephyr:board:: cy8ckit_062_ble

Overview
********
Expand Down Expand Up @@ -30,10 +27,6 @@ enabling you to emulate a BLE host on your computer.
The Cortex-M0+ is a primary core on the board's SoC. It starts first and
enables the CM4 core.

.. image:: img/cy8ckit-062-ble.jpg
:align: center
:alt: CY8CKIT_062_BLE

1. Battery charging indicator (LED6)
2. USB PD output voltage availability indicator (LED7)
3. KitProg2 USB Type-C connector (J10)
Expand Down
9 changes: 1 addition & 8 deletions boards/cypress/cy8ckit_062_wifi_bt/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _cy8ckit_062_wifi_bt:

INFINEON PSOC 6 WiFi-BT Pioneer Kit
###################################
.. zephyr:board:: cy8ckit_062_wifi_bt

Overview
********
Expand All @@ -23,10 +20,6 @@ The PSOC 6 WiFi-BT Pioneer board offers compatibility with Arduino shields.
The Cortex-M0+ is a primary core on the board's SoC. It starts first and
enables the CM4 core.

.. image:: img/cy8ckit_062_wifi_bt_m0.jpg
:align: center
:alt: CY8CKIT_062_WIFI_BT

1. USB PD output voltage availability indicator (LED7)
2. Battery charging indicator (LED6)
3. KitProg2 USB Type-C connector (J10)
Expand Down
5 changes: 1 addition & 4 deletions boards/ene/kb1200_evb/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _ene_kb1200_evb:

ENE KB1200_EVB
##############
.. zephyr:board:: kb1200_evb

Overview
********
Expand Down
9 changes: 1 addition & 8 deletions boards/enjoydigital/litex_vexriscv/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _litex-vexriscv:

LiteX VexRiscv
##############
.. zephyr:board:: litex_vexriscv

LiteX VexRiscv is an example of a system on a chip (SoC) that consists of
a `VexRiscv processor <https://github.com/SpinalHDL/VexRiscv>`_
Expand All @@ -20,10 +17,6 @@ LiteX VexRiscv SoC implementation generated for the
<https://store.digilentinc.com/arty-a7-artix-7-fpga-development-board-for-makers-and-hobbyists>`_
or `SDI-MIPI Video Converter <https://github.com/antmicro/sdi-mipi-video-converter>`_.

.. image:: img/litex_vexriscv.jpg
:align: center
:alt: LiteX VexRiscv on Digilent Arty 35T Board

LiteX is based on
`Migen <https://m-labs.hk/gateware/migen/>`_/`MiSoC SoC builder <https://github.com/m-labs/misoc>`_
and provides ready-made system components such as buses, streams, interconnects,
Expand Down
5 changes: 1 addition & 4 deletions boards/ite/it82xx2_evb/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _it82xx2_evb:

ITE IT82XX2 series
######################
.. zephyr:board:: it82xx2_evb

Overview
********
Expand Down
5 changes: 1 addition & 4 deletions boards/ite/it8xxx2_evb/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _it8xxx2_evb:

ITE IT8XXX2 series
######################
.. zephyr:board:: it8xxx2_evb
Overview
********
Expand Down
5 changes: 1 addition & 4 deletions boards/lowrisc/opentitan_earlgrey/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _opentitan_earlgrey:

OpenTitan Earl Grey
###################
.. zephyr:board:: opentitan_earlgrey

Overview
********
Expand Down
3 changes: 0 additions & 3 deletions boards/rakwireless/rak5010/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
.. zephyr:board:: rak5010

RAK5010
#######

Overview
********

Expand Down
9 changes: 1 addition & 8 deletions boards/seagate/faze/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _faze:

Seagate FireCuda Gaming SSD (FaZe) board
########################################
.. zephyr:board:: faze

Overview
********
Expand All @@ -14,10 +11,6 @@ through I2C and GPIOs.

This Zephyr port is running on the NXP LPC11U67 MCU.

.. image:: firecuda-gaming-ssd.jpg
:align: center
:alt: Seagate FireCuda Gaming SSD

Hardware
********

Expand Down
5 changes: 1 addition & 4 deletions boards/seagate/legend/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _legend:

Legend
######
.. zephyr:board:: legend

Overview
********
Expand Down
11 changes: 1 addition & 10 deletions boards/up-bridge-the-gap/up_squared/doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
.. _up_squared:

UP Squared
##########
.. zephyr:board:: up_squared

Overview
********
Expand All @@ -11,12 +8,6 @@ performance and low power consumption. It features the latest Intel |reg| Apollo
Lake Celeron |trade| and Pentium |trade| Processors with only 4W of Scenario Design Power and
a powerful and flexible Intel |reg| FPGA Altera MAX 10 onboard.

.. figure:: img/up_squared.jpg
:align: center
:alt: UP Squared

Up Squared (Credit: https://up-board.org)

This board configuration enables kernel support for the `UP Squared`_ board.

.. note::
Expand Down
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
:orphan:

.. _up_squared_pro_7000_board:

UP Squared Pro 7000
###################
.. zephyr:board:: up_squared_pro_7000

Overview
********
Expand Down
4 changes: 2 additions & 2 deletions doc/LICENSING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ ENE KB1200_EVB Board OpenOCD Configuration
------------------------------------------

* *Licensing:* `GPLv2 License`_
* *Impact:* This file is used by `OpenOCD`_ when programming and debugging the :ref:`ene_kb1200_evb`
board. It is never linked into the firmware.
* *Impact:* This file is used by `OpenOCD`_ when programming and debugging the
:zephyr:board:`kb1200_evb` board. It is never linked into the firmware.
* *Files:*

* :zephyr_file:`boards/ene/kb1200_evb/support/openocd.cfg`
Expand Down
123 changes: 59 additions & 64 deletions doc/_extensions/zephyr/domain/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@

from anytree import ChildResolverError, Node, PreOrderIter, Resolver, search
from docutils import nodes
from docutils.parsers.rst import directives
from docutils.parsers.rst import directives, roles
from docutils.statemachine import StringList
from sphinx import addnodes
from sphinx.application import Sphinx
Expand Down Expand Up @@ -797,55 +797,33 @@ def run(self):
result_nodes.append(note)
return result_nodes

# Add the note before any tables
note = nodes.admonition(classes=["legend"])
note += nodes.title(text="Table Legend", classes=["note"])

legend = nodes.definition_list(classes=["supported-hardware field-list"])

def add_legend_item(legend_list, term_text, term_classes, definition_text):
dl_item = nodes.definition_list_item()
dt = nodes.term()
dt += nodes.inline("", term_text, classes=term_classes)
dd = nodes.definition()
dd += nodes.Text(definition_text)
dl_item += dt
dl_item += dd
legend_list += dl_item

add_legend_item(
legend, "on-chip", ["location-chip", "onchip"], "Feature integrated in the SoC."
)
add_legend_item(
legend, "on-board", ["location-chip", "onboard"], "Feature present on the board."
)
add_legend_item(
legend,
"2",
["count", "okay-count"],
"Number of instances of the feature that are present and enabled.",
)
add_legend_item(
legend,
"2",
["count", "disabled-count"],
"Number of instances of the feature that are present but initially disabled.",
)

dl_item = nodes.definition_list_item()
dt = nodes.term()
dt += nodes.literal(text="vnd,foo")
dd = nodes.definition()
dd += nodes.Text(
"Compatible string for the Devicetree binding matching the feature. "
"Click on the link to checkout the binding documentation."
)
dl_item += dt
dl_item += dd
legend += dl_item

note += legend
result_nodes.append(note)
html_contents = """<div class="legend admonition">
<dl class="supported-hardware field-list">
<dt>
<span class="location-chip onchip">on-chip</span> /
<span class="location-chip onboard">on-board</span>
</dt>
<dd>
Feature integrated in the SoC / present on the board.
</dd>
<dt>
<span class="count okay-count">2</span> /
<span class="count disabled-count">2</span>
</dt>
<dd>
Number of instances that are enabled / disabled. <br/>
Click on the label to see the first instance of this feature in the board/SoC DTS files.
</dd>
<dt>
<code class="docutils literal notranslate"><span class="pre">vnd,foo</span></code>
</dt>
<dd>
Compatible string for the Devicetree binding matching the feature. <br/>
Click on the link to view the binding documentation.
</dd>
</dl>
</div>"""
result_nodes.append(nodes.raw("", html_contents, format="html"))

for target, features in sorted(supported_features.items()):
if not features:
Expand Down Expand Up @@ -893,7 +871,7 @@ def feature_sort_key(feature):

for i, (key, value) in enumerate(items):
row = nodes.row()
if value.get("disabled_count", 0) > 0 and value.get("okay_count", 0) == 0:
if value.get("disabled_nodes", []) and not value.get("okay_nodes", []):
row["classes"].append("disabled")

# TYPE column
Expand Down Expand Up @@ -934,22 +912,39 @@ def feature_sort_key(feature):
desc_para += nodes.Text(value["description"])

# Add count indicators for okay and not-okay instances
okay_count = value.get("okay_count", 0)
disabled_count = value.get("disabled_count", 0)
okay_nodes = value.get("okay_nodes", [])
disabled_nodes = value.get("disabled_nodes", [])

if okay_count > 0:
okay_count_indicator = nodes.inline(
classes=["count", "okay-count"],
text=str(okay_count),
)
desc_para += okay_count_indicator
role_fn, _ = roles.role(
"zephyr_file", self.state_machine.language, self.lineno, self.state.reporter
)

def create_count_indicator(nodes_list, class_type, role_function=role_fn):
if not nodes_list:
return None

count = len(nodes_list)

if role_function is None:
return nodes.inline(
classes=["count", f"{class_type}-count"], text=str(count)
)

if disabled_count > 0:
disabled_count_indicator = nodes.inline(
classes=["count", "disabled-count"],
text=str(disabled_count),
# Create a reference to the first node in the list
first_node = nodes_list[0]
file_ref = f"{count} <{first_node['filename']}#L{first_node['lineno']}>"

role_nodes, _ = role_function(
"zephyr_file", file_ref, file_ref, self.lineno, self.state.inliner
)
desc_para += disabled_count_indicator

count_node = role_nodes[0]
count_node["classes"] = ["count", f"{class_type}-count"]

return count_node

desc_para += create_count_indicator(okay_nodes, "okay")
desc_para += create_count_indicator(disabled_nodes, "disabled")

desc_entry += desc_para
row += desc_entry
Expand Down
2 changes: 1 addition & 1 deletion doc/_extensions/zephyr/domain/static/css/board.css
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,6 @@

.legend {
font-size: 0.9em;
max-width: 600px;
border-radius: 6px;
margin: auto;

Expand Down Expand Up @@ -179,6 +178,7 @@
font-size: 0.7em;
font-weight: 600;
margin-left: 4px;
padding-right: 6px !important;

&::before {
content: "×";
Expand Down
Loading
Loading