boards: Update documentation links
Updates documentation links for shortened paths Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
This commit is contained in:
Jamie McCrae
committed by
Carles Cufi
Carles Cufi
parent
eb5c3e6f79
commit
0d719e004b
@@ -80,7 +80,7 @@ features:
|
||||
More details about the board can be found at `96Boards website`_.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_aerocore2/96b_aerocore2_defconfig`
|
||||
:zephyr_file:`boards/96boards/aerocore2/96b_aerocore2_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -78,7 +78,7 @@ More information about the board can be found at the
|
||||
`ARGONKEY website`_.
|
||||
|
||||
The default board configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_argonkey/96b_argonkey_defconfig`
|
||||
:zephyr_file:`boards/96boards/argonkey/96b_argonkey_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -164,7 +164,7 @@ features:
|
||||
+-----------+------------+-------------------------------------+
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_avenger96/96b_avenger96_defconfig`
|
||||
:zephyr_file:`boards/96boards/avenger96/96b_avenger96_defconfig`
|
||||
|
||||
|
||||
Connections and IOs
|
||||
|
||||
@@ -50,7 +50,7 @@ Supported Features
|
||||
+-----------+------------+-------------------------------------+
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_carbon/96b_carbon_nrf51822_defconfig`
|
||||
:zephyr_file:`boards/96boards/carbon/96b_carbon_nrf51822_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -101,7 +101,7 @@ hardware features:
|
||||
More details about the board can be found at `96Boards website`_.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_carbon/96b_carbon_stm32f401xe_defconfig`
|
||||
:zephyr_file:`boards/96boards/carbon/96b_carbon_stm32f401xe_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -75,7 +75,7 @@ features:
|
||||
More details about the board can be found at `96Boards website`_.
|
||||
|
||||
The default board configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_neonkey/96b_neonkey_defconfig`
|
||||
:zephyr_file:`boards/96boards/neonkey/96b_neonkey_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -76,7 +76,7 @@ See `Nordic Semiconductor Infocenter`_ for a complete list of nRF52-based
|
||||
board hardware features.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_nitrogen/96b_nitrogen_defconfig`
|
||||
:zephyr_file:`boards/96boards/nitrogen/96b_nitrogen_defconfig`
|
||||
|
||||
Pin Mapping
|
||||
===========
|
||||
|
||||
@@ -74,7 +74,7 @@ hardware features:
|
||||
+-----------+------------+-------------------------------------+
|
||||
|
||||
The default board configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_stm32_sensor_mez/96b_stm32_sensor_mez_defconfig`
|
||||
:zephyr_file:`boards/96boards/stm32_sensor_mez/96b_stm32_sensor_mez_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -71,7 +71,7 @@ features:
|
||||
+-----------+------------+-------------------------------------+
|
||||
|
||||
The default board configuration can be found in
|
||||
:zephyr_file:`boards/96boards/96b_wistrio/96b_wistrio_defconfig`
|
||||
:zephyr_file:`boards/96boards/wistrio/96b_wistrio_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -58,7 +58,7 @@ following hardware features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig file
|
||||
:zephyr_file:`boards/adafruit/adafruit_feather_m0_basic_proto/adafruit_feather_m0_basic_proto_defconfig`.
|
||||
:zephyr_file:`boards/adafruit/feather_m0_basic_proto/adafruit_feather_m0_basic_proto_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -61,7 +61,7 @@ following hardware features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig file
|
||||
:zephyr_file:`boards/adafruit/adafruit_feather_m0_lora/adafruit_feather_m0_lora_defconfig`.
|
||||
:zephyr_file:`boards/adafruit/feather_m0_lora/adafruit_feather_m0_lora_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -61,7 +61,7 @@ hardware features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig file
|
||||
:zephyr_file:`boards/adafruit/adafruit_grand_central_m4_express/adafruit_grand_central_m4_express_defconfig`.
|
||||
:zephyr_file:`boards/adafruit/grand_central_m4_express/adafruit_grand_central_m4_express_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -127,7 +127,7 @@ with the :zephyr:code-sample:`led-apa102` sample application.
|
||||
|
||||
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/adafruit/adafruit_itsybitsy/adafruit_itsybitsy_nrf52840.dts`.
|
||||
:zephyr_file:`boards/adafruit/itsybitsy/adafruit_itsybitsy_nrf52840.dts`.
|
||||
|
||||
Programming and Debugging
|
||||
*************************
|
||||
|
||||
@@ -63,7 +63,7 @@ hardware features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig file
|
||||
:zephyr_file:`boards/adafruit/adafruit_itsybitsy_m4_express/adafruit_itsybitsy_m4_express_defconfig`.
|
||||
:zephyr_file:`boards/adafruit/itsybitsy_m4_express/adafruit_itsybitsy_m4_express_defconfig`.
|
||||
|
||||
Zephyr can use the default Cortex-M SYSTICK timer or the SAM0 specific RTC.
|
||||
To use the RTC, set :code:`CONFIG_CORTEX_M_SYSTICK=n` and set
|
||||
|
||||
@@ -56,7 +56,7 @@ features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig file
|
||||
:zephyr_file:`boards/adafruit/adafruit_trinket_m0/adafruit_trinket_m0_defconfig`.
|
||||
:zephyr_file:`boards/adafruit/trinket_m0/adafruit_trinket_m0_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -82,7 +82,7 @@ following hardware features:
|
||||
|
||||
The default configuration can be found in the defconfig file:
|
||||
|
||||
:zephyr_file:`boards/adi/adi_eval_adin1110ebz/adi_eval_adin1110ebz_defconfig`
|
||||
:zephyr_file:`boards/adi/eval_adin1110ebz/adi_eval_adin1110ebz_defconfig`
|
||||
|
||||
|
||||
Connections and IOs
|
||||
|
||||
@@ -86,7 +86,7 @@ following hardware features:
|
||||
|
||||
The default configuration can be found in the defconfig file:
|
||||
|
||||
:zephyr_file:`boards/adi/adi_eval_adin2111ebz/adi_eval_adin2111ebz_defconfig`
|
||||
:zephyr_file:`boards/adi/eval_adin2111ebz/adi_eval_adin2111ebz_defconfig`
|
||||
|
||||
|
||||
Connections and IOs
|
||||
|
||||
@@ -90,7 +90,7 @@ The Zephyr stm32f469i_disco board configuration supports the following hardware
|
||||
Other hardware features are not yet supported on Zephyr porting.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/adi/adi_sdp_k1/adi_sdp_k1_defconfig`
|
||||
:zephyr_file:`boards/adi/sdp_k1/adi_sdp_k1_defconfig`
|
||||
|
||||
Pin Mapping
|
||||
===========
|
||||
|
||||
@@ -56,7 +56,7 @@ See `Arduino Due website`_ and `Atmel SAM3X8E Datasheet`_ for a complete
|
||||
list of Arduino Due board hardware features.
|
||||
|
||||
The default configuration can be found in the Kconfig
|
||||
:zephyr_file:`boards/arduino/arduino_due/arduino_due_defconfig`.
|
||||
:zephyr_file:`boards/arduino/due/arduino_due_defconfig`.
|
||||
|
||||
.. note::
|
||||
For I2C, pull-up resistors are required for using SCL1 and SDA1 (near IO13).
|
||||
|
||||
@@ -66,7 +66,7 @@ features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig
|
||||
:zephyr_file:`boards/arduino/arduino_mkrzero/arduino_mkrzero_defconfig`.
|
||||
:zephyr_file:`boards/arduino/mkrzero/arduino_mkrzero_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -64,7 +64,7 @@ features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig
|
||||
:zephyr_file:`boards/arduino/arduino_nano_33_iot/arduino_nano_33_iot_defconfig`.
|
||||
:zephyr_file:`boards/arduino/nano_33_iot/arduino_nano_33_iot_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -63,7 +63,7 @@ The current Zephyr arduino_opta_m4 board configuration supports the following ha
|
||||
Other hardware features are not yet supported on Zephyr porting.
|
||||
|
||||
The default configuration per core can be found in the defconfig file:
|
||||
:zephyr_file:`boards/arduino/arduino_opta/arduino_opta_stm32h747xx_m4_defconfig`
|
||||
:zephyr_file:`boards/arduino/opta/arduino_opta_stm32h747xx_m4_defconfig`
|
||||
|
||||
Pin Mapping
|
||||
===========
|
||||
|
||||
@@ -58,7 +58,7 @@ features:
|
||||
Other hardware features are not currently supported by Zephyr.
|
||||
|
||||
The default configuration can be found in the Kconfig
|
||||
:zephyr_file:`boards/arduino/arduino_zero/arduino_zero_defconfig`.
|
||||
:zephyr_file:`boards/arduino/zero/arduino_zero_defconfig`.
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -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/circuitdojo_feather/circuitdojo_feather_nrf9160_common.dtsi`.
|
||||
:zephyr_file:`boards/circuit_dojo/feather/circuitdojo_feather_nrf9160_common.dtsi`.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
@@ -101,7 +101,7 @@ The Zephyr Dragino LSN50 board configuration supports the following hardware fea
|
||||
Other hardware features are not yet supported on this Zephyr port.
|
||||
|
||||
The default configuration can be found in the defconfig file:
|
||||
:zephyr_file:`boards/dragino/dragino_lsn50/dragino_lsn50_defconfig`
|
||||
:zephyr_file:`boards/dragino/lsn50/dragino_lsn50_defconfig`
|
||||
|
||||
|
||||
Connections and IOs
|
||||
|
||||
@@ -100,7 +100,7 @@ The Zephyr Dragino NBSN95 board configuration supports the following hardware fe
|
||||
Other hardware features are not yet supported on this Zephyr port.
|
||||
|
||||
The default configuration can be found in the defconfig file:
|
||||
:zephyr_file:`boards/dragino/dragino_nbsn95/dragino_nbsn95_defconfig`
|
||||
:zephyr_file:`boards/dragino/nbsn95/dragino_nbsn95_defconfig`
|
||||
|
||||
|
||||
Connections and IOs
|
||||
|
||||
@@ -211,7 +211,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/ebyte/ebyte_e73_tbb/ebyte_e73_tbb_nrf52832.dts`.
|
||||
:zephyr_file:`boards/ebyte/e73_tbb/ebyte_e73_tbb_nrf52832.dts`.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
@@ -48,7 +48,7 @@ The following features are supported:
|
||||
Other features (such as I2C) are not available in Zephyr.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/google/google_kukui/google_kukui_defconfig`
|
||||
:zephyr_file:`boards/google/kukui/google_kukui_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -32,7 +32,7 @@ The following features are supported:
|
||||
+-----------+------------+-------------------------------------+
|
||||
|
||||
The default configuration can be found in the defconfig file:
|
||||
:zephyr_file:`boards/google/google_twinkie_v2/google_twinkie_v2_defconfig`
|
||||
:zephyr_file:`boards/google/twinkie_v2/google_twinkie_v2_defconfig`
|
||||
|
||||
Pin Mapping
|
||||
===========
|
||||
|
||||
@@ -136,7 +136,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/holyiot/holyiot_yj16019/holyiot_yj16019.dts`.
|
||||
in :zephyr_file:`boards/holyiot/yj16019/holyiot_yj16019.dts`.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
@@ -139,7 +139,7 @@ undocumented rimage precedence rules it's best to use only one way at a time.
|
||||
|
||||
- For board-specific needs you can define WEST_SIGN_OPTS in
|
||||
``boards/my/board/board.cmake``, see example in
|
||||
``soc/intel/intel_adsp/common/CMakeLists.txt``
|
||||
``soc/intel/adsp/common/CMakeLists.txt``
|
||||
|
||||
Starting with Zephyr 3.6.0, ``west flash`` does not invoke ``west sign``
|
||||
anymore and you cannot pass rimage parameters to ``west flash`` anymore. To
|
||||
|
||||
@@ -41,7 +41,7 @@ hardware features:
|
||||
Other hardware features have not been enabled yet for this board.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/intel/intel_socfpga/agilex_socdk/intel_socfpga_agilex_socdk_defconfig`
|
||||
:zephyr_file:`boards/intel/socfpga/agilex_socdk/intel_socfpga_agilex_socdk_defconfig`
|
||||
|
||||
Programming and Debugging
|
||||
*************************
|
||||
|
||||
@@ -169,7 +169,7 @@ application.
|
||||
``Important!!!`` : Before flashing the board a ``preloader`` is required,
|
||||
you can download `cv_soc_devkit_ghrd.tar.gz <https://releases.rocketboards.org/release/2018.05/gsrd/hw/cv_soc_devkit_ghrd.tar.gz>`_,
|
||||
extract the file and copy ``cv_soc_devkit_ghrd/software/preloader/uboot-socfpga/spl/u-boot-spl``
|
||||
to :zephyr_file:`boards/intel/intel_socfpga_std/cyclonev_socdk/support/`
|
||||
to :zephyr_file:`boards/intel/socfpga_std/cyclonev_socdk/support/`
|
||||
|
||||
.. zephyr-app-commands::
|
||||
:zephyr-app: samples/hello_world
|
||||
@@ -184,7 +184,7 @@ using the customized OpenOCD runner script :zephyr_file:`scripts/west_commands/r
|
||||
After it completes the kernel will immediately boot using the GSRD preloader.
|
||||
Notice that there a lot of helper files to ``flash`` the application with
|
||||
OpenOCD and GDB Debbuger (Zephyr SDK must be installed in your machine).
|
||||
This files should be located in :zephyr_file:`boards/intel/intel_socfpga_std/cyclonev_socdk/support/` including:
|
||||
This files should be located in :zephyr_file:`boards/intel/socfpga_std/cyclonev_socdk/support/` including:
|
||||
|
||||
* blaster_6810.hex : USB-BlasterII firmware
|
||||
* tmp_preloader_dl_cmd.txt : GDB helper file to load the preloader
|
||||
@@ -294,7 +294,7 @@ You will see output similar to the following:
|
||||
warning: No executable has been specified and target does not support
|
||||
determining executable automatically. Try using the "file" command.
|
||||
0xffff147c in ?? ()
|
||||
warning: /home/demo/zephyrproject/zephyr/boards/intel/intel_socfpga_std/cyclonev_socdk/support/tmp_appli_debug_cmd.gdb: No such file or directory
|
||||
warning: /home/demo/zephyrproject/zephyr/boards/intel/socfpga_std/cyclonev_socdk/support/tmp_appli_debug_cmd.gdb: No such file or directory
|
||||
[Inferior 1 (Remote target) detached]
|
||||
Info : dropped 'gdb' connection
|
||||
shutdown command invoked
|
||||
|
||||
@@ -32,7 +32,7 @@ hardware features:
|
||||
Other hardware features have not been enabled yet for this board.
|
||||
|
||||
The default configuration can be found in (NON-SMP)
|
||||
:zephyr_file:`boards/khadas/khadas_edgev/khadas_edgev_defconfig`
|
||||
:zephyr_file:`boards/khadas/edgev/khadas_edgev_defconfig`
|
||||
|
||||
There are multiple serial ports on the board: Zephyr is using
|
||||
uart2 as serial console.
|
||||
|
||||
@@ -55,7 +55,7 @@ The Zephyr MikroE Clicker 2 configuration supports the following hardware featur
|
||||
Other hardware features have not been enabled yet for this board.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/mikroe/mikroe_clicker_2/mikroe_clicker_2_defconfig`
|
||||
:zephyr_file:`boards/mikroe/clicker_2/mikroe_clicker_2_defconfig`
|
||||
|
||||
Connections and IOs
|
||||
===================
|
||||
|
||||
@@ -86,7 +86,7 @@ features:
|
||||
Other hardware features have not been enabled yet for this board.
|
||||
|
||||
The default configuration can be found in
|
||||
:zephyr_file:`boards/mikroe/mikroe_mini_m4_for_stm32/mikroe_mini_m4_for_stm32_defconfig`
|
||||
:zephyr_file:`boards/mikroe/mini_m4_for_stm32/mikroe_mini_m4_for_stm32_defconfig`
|
||||
|
||||
Serial Port
|
||||
===========
|
||||
|
||||
@@ -83,8 +83,8 @@ Other hardware features are not yet supported on this Zephyr port.
|
||||
|
||||
The default configuration can be found in:
|
||||
|
||||
- :zephyr_file:`boards/olimex/olimex_lora_stm32wl_devkit/olimex_lora_stm32wl_devkit_defconfig`
|
||||
- :zephyr_file:`boards/olimex/olimex_lora_stm32wl_devkit/olimex_lora_stm32wl_devkit.dts`
|
||||
- :zephyr_file:`boards/olimex/lora_stm32wl_devkit/olimex_lora_stm32wl_devkit_defconfig`
|
||||
- :zephyr_file:`boards/olimex/lora_stm32wl_devkit/olimex_lora_stm32wl_devkit.dts`
|
||||
|
||||
Programming and Debugging
|
||||
*************************
|
||||
|
||||
@@ -187,7 +187,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/raytac/raytac_mdbt50q_db_33/raytac_mdbt50q_db_33_nrf52833.dts`.
|
||||
:zephyr_file:`boards/raytac/mdbt50q_db_33/raytac_mdbt50q_db_33_nrf52833.dts`.
|
||||
|
||||
Selecting the pins
|
||||
==================
|
||||
|
||||
@@ -189,7 +189,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/raytac/raytac_mdbt50q_db_40/raytac_mdbt50q_db_40_nrf52840.dts`.
|
||||
:zephyr_file:`boards/raytac/mdbt50q_db_40/raytac_mdbt50q_db_40_nrf52840.dts`.
|
||||
|
||||
Selecting the pins
|
||||
==================
|
||||
|
||||
@@ -139,7 +139,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/sparkfun/sparkfun_thing_plus/sparkfun_thing_plus_nrf9160_common.dtsi`.
|
||||
:zephyr_file:`boards/sparkfun/thing_plus/sparkfun_thing_plus_nrf9160_common.dtsi`.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
@@ -52,7 +52,7 @@ features:
|
||||
|
||||
The default configuration can be found in the defconfig file:
|
||||
|
||||
:zephyr_file:`boards/weact/weact_stm32g431_core/weact_stm32g431_core_defconfig`
|
||||
:zephyr_file:`boards/weact/stm32g431_core/weact_stm32g431_core_defconfig`
|
||||
|
||||
Pin Mapping
|
||||
===========
|
||||
|
||||
@@ -150,7 +150,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/wurth_elektronik/we_proteus2ev/we_proteus2ev_nrf52832.dts`.
|
||||
:zephyr_file:`boards/wurth_elektronik/proteus2ev/we_proteus2ev_nrf52832.dts`.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
@@ -151,7 +151,7 @@ LEDs on 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/wurth_elektronik/we_proteus3ev/we_proteus3ev_nrf52840.dts`.
|
||||
:zephyr_file:`boards/wurth_elektronik/proteus3ev/we_proteus3ev_nrf52840.dts`.
|
||||
|
||||
References
|
||||
**********
|
||||
|
||||
Reference in New Issue
Block a user