Skip to content

Commit 54945f7

Browse files
committed
boards: sparkfun: adopt zephyr:board directive
updates a couple boards to make the most of Sphinx board extensions. Signed-off-by: Benjamin Cabé <[email protected]>
1 parent 38fce64 commit 54945f7

File tree

5 files changed

+10
-95
lines changed

5 files changed

+10
-95
lines changed

boards/sparkfun/pro_micro_rp2040/doc/index.rst

Lines changed: 4 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _sparkfun_pro_micro_rp2040:
2-
3-
SparkFun Pro Micro RP2040
4-
#########################
1+
.. zephyr:board:: sparkfun_pro_micro_rp2040
52
63
Overview
74
********
@@ -27,64 +24,10 @@ Hardware
2724
- On-board RGB LED
2825
- 1 Watchdog timer peripheral
2926

30-
31-
.. figure:: img/sparkfun_pro_micro_rp2040.jpg
32-
:align: center
33-
:alt: SparkFun Pro Micro RP2040
34-
35-
SparkFun Pro Micro RP2040 (Image courtesy of SparkFun)
36-
3727
Supported Features
3828
==================
3929

40-
The sparkfun_pro_micro_rp2040 board configuration supports the following
41-
hardware features:
42-
43-
.. list-table::
44-
:header-rows: 1
45-
46-
* - Peripheral
47-
- Kconfig option
48-
- Devicetree compatible
49-
* - NVIC
50-
- N/A
51-
- :dtcompatible:`arm,v6m-nvic`
52-
* - UART
53-
- :kconfig:option:`CONFIG_SERIAL`
54-
- :dtcompatible:`raspberrypi,pico-uart`
55-
* - GPIO
56-
- :kconfig:option:`CONFIG_GPIO`
57-
- :dtcompatible:`raspberrypi,pico-gpio`
58-
* - ADC
59-
- :kconfig:option:`CONFIG_ADC`
60-
- :dtcompatible:`raspberrypi,pico-adc`
61-
* - I2C
62-
- :kconfig:option:`CONFIG_I2C`
63-
- :dtcompatible:`snps,designware-i2c`
64-
* - SPI
65-
- :kconfig:option:`CONFIG_SPI`
66-
- :dtcompatible:`raspberrypi,pico-spi`
67-
* - USB Device
68-
- :kconfig:option:`CONFIG_USB_DEVICE_STACK`
69-
- :dtcompatible:`raspberrypi,pico-usbd`
70-
* - HWINFO
71-
- :kconfig:option:`CONFIG_HWINFO`
72-
- N/A
73-
* - Watchdog Timer (WDT)
74-
- :kconfig:option:`CONFIG_WATCHDOG`
75-
- :dtcompatible:`raspberrypi,pico-watchdog`
76-
* - PWM
77-
- :kconfig:option:`CONFIG_PWM`
78-
- :dtcompatible:`raspberrypi,pico-pwm`
79-
* - Flash
80-
- :kconfig:option:`CONFIG_FLASH`
81-
- :dtcompatible:`raspberrypi,pico-flash`
82-
* - Clock controller
83-
- :kconfig:option:`CONFIG_CLOCK_CONTROL`
84-
- :dtcompatible:`raspberrypi,pico-clock-controller`
85-
* - UART (PIO)
86-
- :kconfig:option:`CONFIG_SERIAL`
87-
- :dtcompatible:`raspberrypi,pico-uart-pio`
30+
.. zephyr:board-supported-hw::
8831
8932
Pin Mapping
9033
===========
@@ -109,6 +52,8 @@ Default Zephyr Peripheral Mapping:
10952
Programming and Debugging
11053
*************************
11154

55+
.. zephyr:board-supported-runners::
56+
11257
Flashing
11358
========
11459

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
board:
22
name: sparkfun_thing_plus_matter_mgm240p
3-
full_name: THING PLUS MATTER
3+
full_name: Thing Plus Matter
44
vendor: sparkfun
55
socs:
66
- name: efr32mg24b020f1536im40

boards/sparkfun/thing_plus_matter_mgm240p/doc/index.rst

Lines changed: 4 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,4 @@
1-
.. _sparkfun_thing_plus_mgm240p:
2-
3-
SparkFun Thing Plus Matter
4-
###########################
1+
.. zephyr:board:: sparkfun_thing_plus_matter_mgm240p
52
63
Overview
74
********
@@ -10,13 +7,6 @@ The MGM240P Mighty Sparkfun Think Plus Matter contains
107
a Wireless System-On-Chip from the EFR32MG24 family built on an
118
ARM Cortex®-M33F processor with excellent low power capabilities.
129

13-
.. figure:: ./img/MGM240P_Thing_Plus.jpg
14-
:height: 260px
15-
:align: center
16-
:alt: MGM240P Sparkfun Think Plus Matter
17-
18-
MGM240P Sparkfun Think Plus Matter (image courtesy of Sparkfun)
19-
2010
Hardware
2111
********
2212

@@ -40,29 +30,7 @@ documents:
4030
Supported Features
4131
==================
4232

43-
The board configuration supports the following hardware features:
44-
45-
+-----------+------------+-------------------------------------+
46-
| Interface | Controller | Driver/Component |
47-
+===========+============+=====================================+
48-
| COUNTER | on-chip | stimer |
49-
+-----------+------------+-------------------------------------+
50-
| FLASH | on-chip | flash memory |
51-
+-----------+------------+-------------------------------------+
52-
| GPIO | on-chip | gpio |
53-
+-----------+------------+-------------------------------------+
54-
| UART | on-chip | serial |
55-
+-----------+------------+-------------------------------------+
56-
| TRNG | on-chip | semailbox |
57-
+-----------+------------+-------------------------------------+
58-
| WATCHDOG | on-chip | watchdog |
59-
+-----------+------------+-------------------------------------+
60-
| I2C(M/S) | on-chip | i2c |
61-
+-----------+------------+-------------------------------------+
62-
| RADIO | on-chip | bluetooth |
63-
+-----------+------------+-------------------------------------+
64-
65-
Other hardware features are currently not supported by the port.
33+
.. zephyr:board-supported-hw::
6634
6735
Connections and IOs
6836
===================
@@ -98,6 +66,8 @@ USART0 is connected to the board controller and is used for the console.
9866
Programming and Debugging
9967
*************************
10068

69+
.. zephyr:board-supported-runners::
70+
10171
.. note::
10272
Before using the kit the first time, you should update the J-Link firmware
10373
in Simplicity Studio.

doc/releases/release-notes-4.0.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -320,7 +320,7 @@ Boards & SoC Support
320320
* :zephyr:board:`Seeed XIAO ESP32-S3 Sense Variant <xiao_esp32s3>`: ``xiao_esp32s3``.
321321
* :ref:`sensry.io Ganymed Break-Out-Board (BOB) <ganymed_bob>` (``ganymed_bob``)
322322
* :zephyr:board:`SiLabs SiM3U1xx 32-bit MCU USB Development Kit <sim3u1xx_dk>` (``sim3u1xx_dk``)
323-
* :ref:`SparkFun Thing Plus Matter <sparkfun_thing_plus_mgm240p>` (``sparkfun_thing_plus_matter_mgm240p``)
323+
* :zephyr:board:`SparkFun Thing Plus Matter <sparkfun_thing_plus_matter_mgm240p>` (``sparkfun_thing_plus_matter_mgm240p``)
324324
* :zephyr:board:`ST Nucleo G431KB <nucleo_g431kb>` (``nucleo_g431kb``)
325325
* :zephyr:board:`ST Nucleo H503RB <nucleo_h503rb>` (``nucleo_h503rb``)
326326
* :zephyr:board:`ST Nucleo H755ZI-Q <nucleo_h755zi_q>` (``nucleo_h755zi_q``)

0 commit comments

Comments
 (0)