diff --git a/boards/circuitdojo/feather/doc/index.rst b/boards/circuitdojo/feather/doc/index.rst index 0dd9bac2ed..1988a00e98 100644 --- a/boards/circuitdojo/feather/doc/index.rst +++ b/boards/circuitdojo/feather/doc/index.rst @@ -147,7 +147,7 @@ the board are working properly with Zephyr: You can build and flash the examples to make sure Zephyr is running correctly on your board. The button and LED definitions can be found in -:zephyr_file:`boards/circuit_dojo/feather/circuitdojo_feather_nrf9160_common.dtsi`. +:zephyr_file:`boards/circuitdojo/feather/circuitdojo_feather_nrf9160_common.dtsi`. References ********** diff --git a/boards/electronut/nrf52840_blip/doc/index.rst b/boards/electronut/nrf52840_blip/doc/index.rst index 768168da60..9f78cee51e 100644 --- a/boards/electronut/nrf52840_blip/doc/index.rst +++ b/boards/electronut/nrf52840_blip/doc/index.rst @@ -180,7 +180,7 @@ the board are working properly with Zephyr: You can build and flash the examples to make sure Zephyr is running correctly on your board. The button and LED definitions can be found in -:zephyr_file:`boards/electronut_labs/nrf52840_blip/nrf52840_blip.dts`. +:zephyr_file:`boards/electronut/nrf52840_blip/nrf52840_blip.dts`. References diff --git a/boards/lairdconnect/pinnacle_100_dvk/doc/index.rst b/boards/lairdconnect/pinnacle_100_dvk/doc/index.rst index 483fff9dd8..6feaa13833 100644 --- a/boards/lairdconnect/pinnacle_100_dvk/doc/index.rst +++ b/boards/lairdconnect/pinnacle_100_dvk/doc/index.rst @@ -205,7 +205,7 @@ the board are working properly with Zephyr: You can build and flash the examples to make sure Zephyr is running correctly on your board. The button and LED definitions can be found in -:zephyr_file:`boards/laird_connect/pinnacle_100_dvk/pinnacle_100_dvk.dts`. +:zephyr_file:`boards/lairdconnect/pinnacle_100_dvk/pinnacle_100_dvk.dts`. References ********** diff --git a/boards/nxp/mimxrt1010_evk/doc/index.rst b/boards/nxp/mimxrt1010_evk/doc/index.rst index 7982b8c1e7..f830b49aab 100644 --- a/boards/nxp/mimxrt1010_evk/doc/index.rst +++ b/boards/nxp/mimxrt1010_evk/doc/index.rst @@ -101,7 +101,7 @@ already supported, which can also be re-used on this mimxrt1010_evk board: | PIT | on-chip | pit | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1010_evk/mimxrt1010_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1015_evk/doc/index.rst b/boards/nxp/mimxrt1015_evk/doc/index.rst index 6a08355ff0..65de50063c 100644 --- a/boards/nxp/mimxrt1015_evk/doc/index.rst +++ b/boards/nxp/mimxrt1015_evk/doc/index.rst @@ -99,7 +99,7 @@ already supported, which can also be re-used on this mimxrt1015_evk board: | TRNG | on-chip | entropy | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1015_evk/mimxrt1015_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1020_evk/doc/index.rst b/boards/nxp/mimxrt1020_evk/doc/index.rst index 5a05337264..0043cf5a8a 100644 --- a/boards/nxp/mimxrt1020_evk/doc/index.rst +++ b/boards/nxp/mimxrt1020_evk/doc/index.rst @@ -119,7 +119,7 @@ already supported, which can also be re-used on this mimxrt1020_evk board: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1020_evk/mimxrt1020_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1024_evk/doc/index.rst b/boards/nxp/mimxrt1024_evk/doc/index.rst index 76f0d32999..3838189d20 100644 --- a/boards/nxp/mimxrt1024_evk/doc/index.rst +++ b/boards/nxp/mimxrt1024_evk/doc/index.rst @@ -124,7 +124,7 @@ already supported, which can also be re-used on this mimxrt1024_evk board: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1024_evk/mimxrt1024_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1040_evk/doc/index.rst b/boards/nxp/mimxrt1040_evk/doc/index.rst index f01049b7bb..a73b6a05b4 100644 --- a/boards/nxp/mimxrt1040_evk/doc/index.rst +++ b/boards/nxp/mimxrt1040_evk/doc/index.rst @@ -119,9 +119,8 @@ already supported, which can also be re-used on this mimxrt1040_evk board: | I2C | on-chip | i2c | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: - - :zephyr_file:`boards/nxp/mimxrt1040_evk/mimxrt1040_evk_defconfig` +The default configuration can be found in +:zephyr_file:`boards/nxp/mimxrt1040_evk/mimxrt1040_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1050_evk/doc/index.rst b/boards/nxp/mimxrt1050_evk/doc/index.rst index 8c5fb87a59..1b578ba824 100644 --- a/boards/nxp/mimxrt1050_evk/doc/index.rst +++ b/boards/nxp/mimxrt1050_evk/doc/index.rst @@ -145,9 +145,8 @@ already supported, which can also be re-used on this mimxrt1050_evk board: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: - - :zephyr_file:`boards/nxp/mimxrt1050_evk/mimxrt1050_evk_defconfig` +The default configuration can be found in +:zephyr_file:`boards/nxp/mimxrt1050_evk/mimxrt1050_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1060_evk/doc/index.rst b/boards/nxp/mimxrt1060_evk/doc/index.rst index 3b2c159685..b67ec5e417 100644 --- a/boards/nxp/mimxrt1060_evk/doc/index.rst +++ b/boards/nxp/mimxrt1060_evk/doc/index.rst @@ -153,7 +153,7 @@ already supported, which can also be re-used on this mimxrt1060_evk board: | PIT | on-chip | pit | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1060_evk/mimxrt1060_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1062_fmurt6/doc/index.rst b/boards/nxp/mimxrt1062_fmurt6/doc/index.rst index dd16e7481e..edcd5bc5f1 100644 --- a/boards/nxp/mimxrt1062_fmurt6/doc/index.rst +++ b/boards/nxp/mimxrt1062_fmurt6/doc/index.rst @@ -121,7 +121,7 @@ already supported, which can also be re-used on this mimxrt1060_evk board: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1062_fmurt6/mimxrt1062_fmurt6_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt1064_evk/doc/index.rst b/boards/nxp/mimxrt1064_evk/doc/index.rst index ffdfcd11b7..fb9195693f 100644 --- a/boards/nxp/mimxrt1064_evk/doc/index.rst +++ b/boards/nxp/mimxrt1064_evk/doc/index.rst @@ -151,7 +151,7 @@ configuration supports the following hardware features: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/mimxrt1064_evk/mimxrt1064_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/mimxrt685_evk/doc/index.rst b/boards/nxp/mimxrt685_evk/doc/index.rst index bbaa6d11c4..daed053fcb 100644 --- a/boards/nxp/mimxrt685_evk/doc/index.rst +++ b/boards/nxp/mimxrt685_evk/doc/index.rst @@ -109,9 +109,8 @@ already supported, which can also be re-used on this mimxrt685_evk board: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: - - :zephyr_file:`boards/nxp/mimxrt685_evk/mimxrt685_evk_defconfig` +The default configuration can be found in +:zephyr_file:`boards/nxp/mimxrt685_evk/mimxrt685_evk_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/nxp/vmu_rt1170/doc/index.rst b/boards/nxp/vmu_rt1170/doc/index.rst index 0249dfe3d6..a683fc8ad1 100644 --- a/boards/nxp/vmu_rt1170/doc/index.rst +++ b/boards/nxp/vmu_rt1170/doc/index.rst @@ -124,7 +124,7 @@ following hardware features: | FLEXSPI | on-chip | flash programming | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/nxp/vmu_rt1170/vmu_rt1170_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/olimex/olimex_esp32_evb/doc/index.rst b/boards/olimex/olimex_esp32_evb/doc/index.rst index 38df52c492..b667547f85 100644 --- a/boards/olimex/olimex_esp32_evb/doc/index.rst +++ b/boards/olimex/olimex_esp32_evb/doc/index.rst @@ -83,8 +83,11 @@ features: | WiFi | on-chip | WiFi | +-----------+------------+-------------------------------------+ -The default configuration can be found in the defconfig file: -``boards/xtensa/olimex_esp32_evb/olimex_esp32_evb_defconfig``. +The default configuration can be found in +:zephyr_file:`boards/olimex/olimex_esp32_evb/olimex_esp32_evb_esp32_appcpu_defconfig` +and +:zephyr_file:`boards/olimex/olimex_esp32_evb/olimex_esp32_evb_esp32_procpu_defconfig` + Other hardware features are not currently supported by the port. diff --git a/boards/phytec/mimx8mm_phyboard_polis/doc/index.rst b/boards/phytec/mimx8mm_phyboard_polis/doc/index.rst index 1568a6f3f2..010baf5760 100644 --- a/boards/phytec/mimx8mm_phyboard_polis/doc/index.rst +++ b/boards/phytec/mimx8mm_phyboard_polis/doc/index.rst @@ -187,14 +187,9 @@ For more information about memory mapping see the `i.MX 8M Applications Processor Reference Manual`_ (section 2.1.2 and 2.1.3) At compilation time you have to choose which RAM will be used. This -configuration is done in the file ``boards/arm/mimx8mm_evk/mimx8mm_evk.dts`` +configuration is done in +:zephyr_file:`boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts` with "zephyr,flash" (when CONFIG_XIP=y) and "zephyr,sram" properties. -The available configurations are: - -If you don't want to use the TCM memory area, you can either overwrite the -boards devicetree in your program or edit the board devicetree located here: - -:zephyr_file:`boards/phytec/mimx8mm_phyboard_polis/mimx8mm_phyboard_polis_mimx8mm6_m4.dts`. You also have to set XIP=n or edit the boards defconfig file, if you don't want the TCM memory area to be used. You can find the defconf file here: diff --git a/boards/pjrc/teensy4/doc/index.rst b/boards/pjrc/teensy4/doc/index.rst index 52d8b2aed3..b02acd1661 100644 --- a/boards/pjrc/teensy4/doc/index.rst +++ b/boards/pjrc/teensy4/doc/index.rst @@ -67,11 +67,9 @@ features: | USB | on-chip | USB device | +-----------+------------+-------------------------------------+ - -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/pjrc/teensy4/teensy40_defconfig` - The teensy41 board configuration supports additional hardware features: @@ -83,8 +81,7 @@ features: | ENET | on-chip | ethernet | +-----------+------------+-------------------------------------+ - -The default configuration can be found in the defconfig file: +The default configuration can be found in :zephyr_file:`boards/pjrc/teensy4/teensy41_defconfig` Other hardware features are not currently supported by the port. diff --git a/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst b/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst index 039c2addbf..e2683c5489 100644 --- a/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst +++ b/boards/seeed/lora_e5_dev_board/doc/lora_e5_dev_board.rst @@ -112,8 +112,8 @@ features: Other hardware features are not yet supported on this Zephyr port. The default configuration can be found in: -- :zephyr_file:`boards/seeed_studio/lora_e5_dev_board/lora_e5_dev_board_defconfig` -- :zephyr_file:`boards/seeed_studio/lora_e5_dev_board/lora_e5_dev_board.dts` +- :zephyr_file:`boards/seeed/lora_e5_dev_board/lora_e5_dev_board_defconfig` +- :zephyr_file:`boards/seeed/lora_e5_dev_board/lora_e5_dev_board.dts` Connections and IOs diff --git a/boards/snps/em_starterkit/doc/index.rst b/boards/snps/em_starterkit/doc/index.rst index 9d71b4f767..4390ab2e4c 100644 --- a/boards/snps/em_starterkit/doc/index.rst +++ b/boards/snps/em_starterkit/doc/index.rst @@ -26,18 +26,18 @@ See also this URL for details about the board: The latest version of EM Starter Kit is 2.3, developer can upgrade from 2.0/2.1/2.2 to 2.3 using latest firmware. The default configuration for EM Starter Kit boards can be found in -:zephyr_file:`boards/synopsys/em_starterkit/em_starterkit_defconfig`. +:zephyr_file:`boards/snps/em_starterkit/em_starterkit_defconfig`. The default SoC for this board supported in Zephyr is the EM9D. This configuration is a Harvard Architecture, with a separate instruction bus and data bus. Instruction memory is called ICCM and data memory is called DCCM. The configuration file for EM9D -is found in :zephyr_file:`soc/synopsys/emsk/Kconfig.defconfig.em9d`. +is found in :zephyr_file:`soc/snps/emsk/Kconfig.defconfig.em9d`. If you have a larger program, you can select the EM7D or EM11D, which gives access to 128KB DRAM with i-cache and d-cache. The configuration file for EM7D -is found in :zephyr_file:`soc/synopsys/emsk/Kconfig.defconfig.em7d` and EM11D is -found in :zephyr_file:`soc/synopsys/emsk/Kconfig.defconfig.em11d`. +is found in :zephyr_file:`soc/snps/emsk/Kconfig.defconfig.em7d` and EM11D is +found in :zephyr_file:`soc/snps/emsk/Kconfig.defconfig.em11d`. Hardware diff --git a/boards/snps/nsim/doc/index.rst b/boards/snps/nsim/doc/index.rst index 3f4a250993..24a35ac954 100644 --- a/boards/snps/nsim/doc/index.rst +++ b/boards/snps/nsim/doc/index.rst @@ -39,7 +39,7 @@ available configurations are listed below: .. _board_arc_nsim_prop_args_files: It is recommended to look at precise description of a particular sub-configuration in either -``.props`` or ``.args`` files in :zephyr_file:`boards/synopsys/nsim/support/` directory to understand +``.props`` or ``.args`` files in :zephyr_file:`boards/snps/nsim/support/` directory to understand which options are configured and so will be used on invocation of the simulator. In case of single-core configurations it would be ``.props`` file which contains configuration @@ -55,14 +55,14 @@ simulation anyway). nSIM & MDB don't exactly match, so care should be taken). I.e. for the single-core ``nsim/nsim_hs5x`` platform there are -:zephyr_file:`boards/synopsys/nsim/support/nsim_hs5x.props` and -:zephyr_file:`boards/synopsys/nsim/support/mdb_hs5x.args`. +:zephyr_file:`boards/snps/nsim/support/nsim_hs5x.props` and +:zephyr_file:`boards/snps/nsim/support/mdb_hs5x.args`. For the multi-core configurations there is only ``.args`` file as the multi-core configuration can only be instantiated with help of MDB. I.e. for the multi-core ``nsim/nsim_hs5x/smp`` platform there is only -:zephyr_file:`boards/synopsys/nsim/support/mdb_hs5x_smp.args`. +:zephyr_file:`boards/snps/nsim/support/mdb_hs5x_smp.args`. .. warning:: All nSIM/MDB configurations are used for demo and testing purposes. They are not meant to @@ -90,7 +90,7 @@ Most board sub-configurations support building with both GNU and ARC MWDT toolch there might be exceptions from that, especially for newly added targets. You can check supported toolchains for the sub-configurations in the corresponding ``.yaml`` file. -I.e. for the ``nsim/nsim_hs5x`` board we can check :zephyr_file:`boards/synopsys/nsim/nsim_nsim_hs5x.yaml` +I.e. for the ``nsim/nsim_hs5x`` board we can check :zephyr_file:`boards/snps/nsim/nsim_nsim_hs5x.yaml` The supported toolchains are listed in ``toolchain:`` array in ``.yaml`` file, where we can find: @@ -196,8 +196,8 @@ platform: < *snip* > -- west debug: using runner mdb-nsim - runners.mdb-nsim: mdb -pset=1 -psetname=core0 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/synopsys/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf - runners.mdb-nsim: mdb -pset=2 -psetname=core1 -prop=download=2 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/synopsys/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf + runners.mdb-nsim: mdb -pset=1 -psetname=core0 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/snps/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf + runners.mdb-nsim: mdb -pset=2 -psetname=core1 -prop=download=2 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/snps/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf runners.mdb-nsim: mdb -multifiles=core1,core0 -OKN From that output it's possible to extract MDB commands used for setting-up the GUI debugging @@ -205,8 +205,8 @@ platform: .. code-block:: console - mdb -pset=1 -psetname=core0 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/synopsys/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf - mdb -pset=2 -psetname=core1 -prop=download=2 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/synopsys/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf + mdb -pset=1 -psetname=core0 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/snps/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf + mdb -pset=2 -psetname=core1 -prop=download=2 -nooptions -nogoifmain -toggle=include_local_symbols=1 -nsim @/path/zephyr/boards/snps/nsim/support/mdb_hs5x_smp.args /path/zephyr/build/zephyr/zephyr.elf mdb -multifiles=core1,core0 -OKN Then it's possible to use them directly or in some machinery if required. @@ -316,7 +316,7 @@ GNU & MWDT toolchain compiler options ===================================== The hardware-specific compiler options are set in corresponding SoC cmake file. For ``nsim`` board -it is :zephyr_file:`soc/synopsys/nsim/CMakeLists.txt`. +it is :zephyr_file:`soc/snps/nsim/CMakeLists.txt`. For the GNU toolchain the basic configuration is set via ``-mcpu`` which is defined in generic code and based on the selected CPU model via Kconfig. It still can be forcefully set to required value