From 4dc2f6fd1cacb8cda3a658ccafff2ba00e624b9e Mon Sep 17 00:00:00 2001 From: Jonas Remmert Date: Thu, 24 Oct 2024 00:25:08 +0200 Subject: [PATCH] boards: PHYTEC: phyboard_polis: remove mimx8mm prefix For easier recognition PHYTEC boards have been prefixed with the SoC name. As the new hardware model includes the SoC and cpu, this prefixing is not needed anymore. All PHYTEC eval boards have an individual and unique name and can be found easily via this name. Signed-off-by: Jonas Remmert --- boards/deprecated.cmake | 5 +++- .../phytec/mimx8mm_phyboard_polis/board.yml | 6 ---- .../Kconfig.phyboard_polis} | 4 +-- .../board.cmake | 0 boards/phytec/phyboard_polis/board.yml | 6 ++++ .../doc/img/PEB-EVAL-01.jpg | Bin .../doc/img/phyBOARD-Polis.jpg | Bin .../doc/index.rst | 28 +++++++++--------- .../phyboard_polis-pinctrl.dtsi} | 0 .../phyboard_polis_mimx8mm6_m4.dts} | 6 ++-- .../phyboard_polis_mimx8mm6_m4.yaml} | 4 +-- .../phyboard_polis_mimx8mm6_m4_defconfig} | 0 doc/_scripts/redirects.py | 1 + doc/releases/release-notes-4.0.rst | 2 ++ 14 files changed, 34 insertions(+), 28 deletions(-) delete mode 100644 boards/phytec/mimx8mm_phyboard_polis/board.yml rename boards/phytec/{mimx8mm_phyboard_polis/Kconfig.mimx8mm_phyboard_polis => phyboard_polis/Kconfig.phyboard_polis} (57%) rename boards/phytec/{mimx8mm_phyboard_polis => phyboard_polis}/board.cmake (100%) create mode 100644 boards/phytec/phyboard_polis/board.yml rename boards/phytec/{mimx8mm_phyboard_polis => phyboard_polis}/doc/img/PEB-EVAL-01.jpg (100%) rename boards/phytec/{mimx8mm_phyboard_polis => phyboard_polis}/doc/img/phyBOARD-Polis.jpg (100%) rename boards/phytec/{mimx8mm_phyboard_polis => phyboard_polis}/doc/index.rst (94%) rename boards/phytec/{mimx8mm_phyboard_polis/mimx8mm_phyboard_polis-pinctrl.dtsi => phyboard_polis/phyboard_polis-pinctrl.dtsi} (100%) rename boards/phytec/{mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts => phyboard_polis/phyboard_polis_mimx8mm6_m4.dts} (94%) rename boards/phytec/{mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.yaml => phyboard_polis/phyboard_polis_mimx8mm6_m4.yaml} (78%) rename boards/phytec/{mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4_defconfig => phyboard_polis/phyboard_polis_mimx8mm6_m4_defconfig} (100%) diff --git a/boards/deprecated.cmake b/boards/deprecated.cmake index 2260dd4c038..f15b8fbee42 100644 --- a/boards/deprecated.cmake +++ b/boards/deprecated.cmake @@ -365,7 +365,7 @@ set(mimx8mm_evk_a53_smp_DEPRECATED imx8mm_evk/mimx8mm6/a53/smp ) set(mimx8mm_phyboard_polis_DEPRECATED - mimx8mm_phyboard_polis/mimx8mm6/m4 + phyboard_polis/mimx8mm6/m4 ) set(mimx8mn_evk_a53_DEPRECATED imx8mn_evk/mimx8mn6/a53 @@ -913,3 +913,6 @@ set(yd_esp32_DEPRECATED set(mimx8mp_phyboard_pollux/mimx8ml8/m7_DEPRECATED phyboard_pollux/mimx8ml8/m7 ) +set(mimx8mm_phyboard_polis/mimx8mm6/m4_DEPRECATED + phyboard_polis/mimx8mm6/m4 +) diff --git a/boards/phytec/mimx8mm_phyboard_polis/board.yml b/boards/phytec/mimx8mm_phyboard_polis/board.yml deleted file mode 100644 index 8f834205354..00000000000 --- a/boards/phytec/mimx8mm_phyboard_polis/board.yml +++ /dev/null @@ -1,6 +0,0 @@ -board: - name: mimx8mm_phyboard_polis - full_name: PhyBOARD Polis (NXP i.MX8M Mini) - vendor: phytec - socs: - - name: mimx8mm6 diff --git a/boards/phytec/mimx8mm_phyboard_polis/Kconfig.mimx8mm_phyboard_polis b/boards/phytec/phyboard_polis/Kconfig.phyboard_polis similarity index 57% rename from boards/phytec/mimx8mm_phyboard_polis/Kconfig.mimx8mm_phyboard_polis rename to boards/phytec/phyboard_polis/Kconfig.phyboard_polis index 0039e251a76..e409b0f0fc4 100644 --- a/boards/phytec/mimx8mm_phyboard_polis/Kconfig.mimx8mm_phyboard_polis +++ b/boards/phytec/phyboard_polis/Kconfig.phyboard_polis @@ -2,6 +2,6 @@ # Copyright 2024 NXP # SPDX-License-Identifier: Apache-2.0 -config BOARD_MIMX8MM_PHYBOARD_POLIS +config BOARD_PHYBOARD_POLIS select SOC_PART_NUMBER_MIMX8MM6DVTLZ - select SOC_MIMX8MM6_M4 if BOARD_MIMX8MM_PHYBOARD_POLIS_MIMX8MM6_M4 + select SOC_MIMX8MM6_M4 if BOARD_PHYBOARD_POLIS_MIMX8MM6_M4 diff --git a/boards/phytec/mimx8mm_phyboard_polis/board.cmake b/boards/phytec/phyboard_polis/board.cmake similarity index 100% rename from boards/phytec/mimx8mm_phyboard_polis/board.cmake rename to boards/phytec/phyboard_polis/board.cmake diff --git a/boards/phytec/phyboard_polis/board.yml b/boards/phytec/phyboard_polis/board.yml new file mode 100644 index 00000000000..2ca447ffb92 --- /dev/null +++ b/boards/phytec/phyboard_polis/board.yml @@ -0,0 +1,6 @@ +board: + name: phyboard_polis + full_name: phyBOARD-Polis i.MX8M Mini + vendor: phytec + socs: + - name: mimx8mm6 diff --git a/boards/phytec/mimx8mm_phyboard_polis/doc/img/PEB-EVAL-01.jpg b/boards/phytec/phyboard_polis/doc/img/PEB-EVAL-01.jpg similarity index 100% rename from boards/phytec/mimx8mm_phyboard_polis/doc/img/PEB-EVAL-01.jpg rename to boards/phytec/phyboard_polis/doc/img/PEB-EVAL-01.jpg diff --git a/boards/phytec/mimx8mm_phyboard_polis/doc/img/phyBOARD-Polis.jpg b/boards/phytec/phyboard_polis/doc/img/phyBOARD-Polis.jpg similarity index 100% rename from boards/phytec/mimx8mm_phyboard_polis/doc/img/phyBOARD-Polis.jpg rename to boards/phytec/phyboard_polis/doc/img/phyBOARD-Polis.jpg diff --git a/boards/phytec/mimx8mm_phyboard_polis/doc/index.rst b/boards/phytec/phyboard_polis/doc/index.rst similarity index 94% rename from boards/phytec/mimx8mm_phyboard_polis/doc/index.rst rename to boards/phytec/phyboard_polis/doc/index.rst index b159b5a1ab7..f1229b4b17b 100644 --- a/boards/phytec/mimx8mm_phyboard_polis/doc/index.rst +++ b/boards/phytec/phyboard_polis/doc/index.rst @@ -1,7 +1,7 @@ -.. _mimx8mm_phyboard_polis: +.. _phyboard_polis: -PhyBOARD Polis (NXP i.MX8M Mini) -################################ +phyBOARD-Polis i.MX8M Mini +########################## Overview ******** @@ -61,7 +61,7 @@ the phyCORE-i.MX 8M Mini/Nano. .. image:: img/phyBOARD-Polis.jpg :align: center - :alt: PhyBOARD Polis + :alt: phyBOARD-Polis :width: 500 More information about the board can be found at the @@ -70,8 +70,8 @@ More information about the board can be found at the Supported Features ================== -The Zephyr ``mimx8mm_phyboard_polis/mimx8mm6/m4`` board configuration supports the following -hardware features: +The Zephyr ``phyboard_polis/mimx8mm6/m4`` board target configuration supports +the following hardware features: +-----------+------------+-------------------------------------+ | Interface | Controller | Driver/Component | @@ -96,7 +96,7 @@ hardware features: +-----------+------------+-------------------------------------+ The default configuration can be found in the defconfig file: -:zephyr_file:`boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4_defconfig`. +:zephyr_file:`boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4_defconfig`. It is recommended to disable peripherals used by the M4 core on the Linux host. @@ -111,7 +111,7 @@ The following components are tested and working correctly. UART: ----- -Zephyr is configured to use UART4 on the PhyBoard Polis by default to minimize +Zephyr is configured to use UART4 on the phyBOARD-Polis by default to minimize problems with the A53-Core because UART4 is only accessible from the M4-Core. +---------------+-----------------+-----------------------------------+ @@ -137,7 +137,7 @@ problems with the A53-Core because UART4 is only accessible from the M4-Core. SPI: ---- -ECSPI is disabled by default. On phyBOARD Polis, the SoC's ECSPI3 is not +ECSPI is disabled by default. On phyBOARD-Polis, the SoC's ECSPI3 is not usable. ECSPI1 is connected to the MCP2518 CAN controller with a chip select. Another device can be connected via the expansion header (X8): @@ -174,9 +174,9 @@ devicetree. .. warning:: There is a bug in the MCP2518 driver that causes the enable pin of the transceiver to be not set. This causes a ENETDOWN error when trying to send - a CAN frame. Receiving CAN frames in `listen-only` mode is possible. + a CAN frame. Receiving CAN frames in *listen-only* mode is possible. -The Pinout of the PhyBOARD Polis can be found here: +The Pinout of the phyBOARD-Polis can be found here: `PHYTEC website`_ @@ -218,7 +218,7 @@ For more information about memory mapping see the At compilation time you have to choose which RAM will be used. This configuration is done in -:zephyr_file:`boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts` +:zephyr_file:`boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.dts` with "zephyr,flash" and "zephyr,sram" properties. The following configurations are possible for the flash and sram chosen nodes @@ -308,7 +308,7 @@ on UART4. Debugging ========= -The PhyBOARD Polis can be debugged using a JTAG Debugger. +The phyBOARD-Polis can be debugged using a JTAG Debugger. The easiest way to do that is to use a SEGGER JLink Debugger and Phytec's ``PEB-EVAL-01`` Shield, which can be directly connected to the JLink. You can find the JLink Software package here: `JLink Software`_ @@ -391,7 +391,7 @@ For example: disabling ECSPI1 in Linux to use it on the M4-Core with Zephyr: .. _PHYTEC website: https://www.phytec.de/produkte/single-board-computer/phyboard-polis-imx8m-mini/ -.. _PhyBOARD Polis pinout: +.. _phyBOARD-Polis pinout: https://download.phytec.de/Products/phyBOARD-Polis-iMX8M_Mini/TechData/phyCORE-i.MX8M_MINI_Pin_Muxing_Table.A1.xlsx?_ga=2.237582016.1177557183.1660563641-1900651135.1634193918 .. _Remoteproc BSP: diff --git a/boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis-pinctrl.dtsi b/boards/phytec/phyboard_polis/phyboard_polis-pinctrl.dtsi similarity index 100% rename from boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis-pinctrl.dtsi rename to boards/phytec/phyboard_polis/phyboard_polis-pinctrl.dtsi diff --git a/boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts b/boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.dts similarity index 94% rename from boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts rename to boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.dts index 8352a8e9b6b..76f43a91fe3 100644 --- a/boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts +++ b/boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.dts @@ -7,11 +7,11 @@ /dts-v1/; #include -#include "mimx8mm_phyboard_polis-pinctrl.dtsi" +#include "phyboard_polis-pinctrl.dtsi" / { - model = "Phyboard Polis NXP i.MX8M Mini"; - compatible = "nxp,mimx8mm_phyboard_polis"; + model = "phyBOARD-Polis i.MX8M Mini"; + compatible = "nxp,phyboard_polis"; aliases { uart-4 = &uart4; diff --git a/boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.yaml b/boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.yaml similarity index 78% rename from boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.yaml rename to boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.yaml index d2ca6718e1e..5167e4d0aec 100644 --- a/boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.yaml +++ b/boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4.yaml @@ -4,8 +4,8 @@ # SPDX-License-Identifier: Apache-2.0 # -identifier: mimx8mm_phyboard_polis/mimx8mm6/m4 -name: Phyboard Polis i.MX8M Mini +identifier: phyboard_polis/mimx8mm6/m4 +name: phyBOARD-Polis i.MX8M Mini type: mcu arch: arm ram: 128 diff --git a/boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4_defconfig b/boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4_defconfig similarity index 100% rename from boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4_defconfig rename to boards/phytec/phyboard_polis/phyboard_polis_mimx8mm6_m4_defconfig diff --git a/doc/_scripts/redirects.py b/doc/_scripts/redirects.py index 06939caf849..31e7a3b0d19 100644 --- a/doc/_scripts/redirects.py +++ b/doc/_scripts/redirects.py @@ -16,6 +16,7 @@ REDIRECTS = [ # zephyr-keep-sorted-start ('application/index', 'develop/application/index'), ('boards/arduino/uno_r4_minima/doc/index', 'boards/arduino/uno_r4/doc/index'), + ('boards/phytec/mimx8mm_phyboard_polis/doc/index', 'boards/phytec/phyboard_polis/doc/index'), ('boards/phytec/mimx8mp_phyboard_pollux/doc/index', 'boards/phytec/phyboard_pollux/doc/index'), ('boards/rak/index', 'boards/rakwireless/index'), ('boards/rak/rak11720/doc/index', 'boards/rakwireless/rak11720/doc/index'), diff --git a/doc/releases/release-notes-4.0.rst b/doc/releases/release-notes-4.0.rst index f633f54e2a3..da0fa4d054c 100644 --- a/doc/releases/release-notes-4.0.rst +++ b/doc/releases/release-notes-4.0.rst @@ -162,6 +162,8 @@ Boards & SoC Support * Removed the ``nrf54l15pdk`` board, use :ref:`nrf54l15dk_nrf54l15` instead. * PHYTEC: ``mimx8mp_phyboard_pollux`` has been renamed to :ref:`phyboard_pollux`, with the old name marked as deprecated. + * PHYTEC: ``mimx8mm_phyboard_polis`` has been renamed to :ref:`phyboard_polis`, + with the old name marked as deprecated. * Added support for the following shields: