Lines Matching full:your
9 support your :term:`SoC` as well.
50 #. Take the SoC definition from Zephyr v3.6.0 and copy it to your downstream
52 :ref:`zephyr module <modules>` or ``SOC_ROOT``). This will allow your board,
55 When converting your board from the previous to the current hardware model, we
180 Make sure your SoC is supported
183 Start by making sure your SoC is supported by Zephyr. If it is, it's time to
184 :ref:`create-your-board-directory`. If you don't know, try:
188 - asking your SoC vendor
218 files to avoid duplication. If there is no support for your vendor yet, you can
219 add it in a new directory ``zephyr/soc/<VENDOR>/<YOUR-SOC>``; please use
222 .. _create-your-board-directory:
224 Create your board directory
227 Once you've found an existing board that uses your SoC, you can usually start
228 by copy/pasting its board directory and changing its contents for your
231 You need to give your board a unique name. Run ``west boards`` for a list of
232 names that are already taken, and pick something new. Let's say your board is
236 ``<VENDOR>`` is your vendor subdirectory. (You don't have to put your
238 started. See :ref:`custom_board_definition` for documentation on moving your
242 A ``<VENDOR>`` subdirectory is mandatory if contributing your board
243 to Zephyr, but if your board is placed in a local repo, then any folder
244 structure under ``<your-repo>/boards`` is permitted.
255 Your board directory should look like this:
272 Replace ``plank`` with your board's name, of course.
282 in :ref:`devicetree <dt-guide>` format. This declares your SoC, connectors,
301 your build.
303 of your board. You only need this if you're :ref:`contributing-your-board` to
314 Write your board YAML
367 Write your devicetree
371 :file:`boards/<vendor>/plank/plank_<qualifiers>.dts` describes your board
373 your board's name). If you're new to devicetree, see :ref:`devicetree-intro`.
389 /* other chosen settings for your hardware */
393 * Your board-specific hardware: buttons, LEDs, sensors, etc.
399 gpios = < /* GPIO your LED is hooked up to */ >;
407 /* ... your button definitions ... */
449 This section contains concrete examples related to writing your board's
503 Zephyr uses the Kconfig language to configure software features. Your board
584 :file:`.config` whenever an application is compiled for your board.
594 The ``_defconfig`` should contain mandatory settings for your system clock,
600 CONFIG_SYS_CLOCK_HW_CYCLES_PER_SEC=120000000 # set up your clock, etc
605 :file:`.config` whenever an application is compiled for your board revision
611 Now it's time to build and test the application(s) you want to run on your
631 that are not board specific for your board, please follow these guidelines
643 - If your board uses a well-known connector standard (like Arduino, Mikrobus,
644 Grove, or 96Boards connectors), add connector nodes to your DTS and configure
662 - If your board supports networking, configure a default interface.
682 To add ``west flash`` and ``west debug`` support for your board, you need to
683 create a :file:`board.cmake` file in your board directory. This file's job is
684 to configure a "runner" for your board. (There's nothing special you need to
685 do to get ``west build`` support for your board.)
691 Python scripts in your :file:`board.cmake` to support those commands like this
733 - Look for :file:`board.cmake` files for other boards similar to your own for
746 The order of the ``include()`` calls in your :file:`board.cmake` matters. The
902 .. _contributing-your-board:
904 Contributing your board
907 If you want to contribute your board to Zephyr, first -- thanks!
914 #. Add documentation for your board using the template file
916 information on how to build your documentation before submitting
917 your pull request.
919 #. Prepare a pull request adding your board which follows the
928 new board variants. Such board extensions can be done in your custom repository
935 To extend an existing board, first create a :file:`board.yml` in your extended
937 :ref:`create-your-board-directory`.
949 When extending a board, your board directory should look like: