Skip to content

Commit

Permalink
doc: dpdk documentation changes for new dts config
Browse files Browse the repository at this point in the history 
Adjusted DPDK documentation to reflect the changes made to the dts
conf.yaml configuration file.

Bugzilla ID: 1360
Signed-off-by: Nicholas Pratte <npratte@iol.unh.edu>
Signed-off-by: 0-day Robot <robot@bytheb.org>
  • Loading branch information
@ovsrobot
Nicholas Pratte authored and ovsrobot committed Jul 5, 2024
1 parent 0488541 commit 0f64459
Showing 1 changed file with 6 additions and 20 deletions.
26 changes: 6 additions & 20 deletions doc/guides/tools/dts.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -437,14 +437,6 @@ _`Node name`
*string* – A unique identifier for a node.
**Examples**: ``SUT1``, ``TG1``.

_`ARCH`
*string* – The CPU architecture.
**Supported values**: ``x86_64``, ``arm64``, ``ppc64le``.

_`CPU`
*string* – The CPU microarchitecture. Use ``native`` for x86.
**Supported values**: ``native``, ``armv8a``, ``dpaa2``, ``thunderx``, ``xgene1``.

_`OS`
*string* – The operating system. **Supported values**: ``linux``.

Expand All @@ -456,9 +448,6 @@ _`Build target`
*mapping* – Build targets supported by DTS for building DPDK, described as:

==================== =================================================================
``arch`` See `ARCH`_
``os`` See `OS`_
``cpu`` See `CPU`_
``compiler`` See `Compiler`_
``compiler_wrapper`` *string* – Value prepended to the CC variable for the DPDK build.

Expand Down Expand Up @@ -565,18 +554,15 @@ involved in the testing. These can be defined with the following mappings:
| | |
| | **NB**: Use only as last resort. SSH keys are **strongly** preferred. |
+-----------------------+---------------------------------------------------------------------------------------+
| ``arch`` | The architecture of this node. See `ARCH`_ for supported values. |
+-----------------------+---------------------------------------------------------------------------------------+
| ``os`` | The operating system of this node. See `OS`_ for supported values. |
+-----------------------+---------------------------------------------------------------------------------------+
| ``lcores`` | | (*optional*, defaults to 1) *string* – Comma-separated list of logical |
| | | cores to use. An empty string means use all lcores. |
| | |
| | **Example**: ``1,2,3,4,5,18-22`` |
| ``dpdk_config`` | Configuration relating to DPDK (to be specified on SUT Nodes) |
+-----------------------+---------------------------------------------------------------------------------------+
| ``use_first_core`` | (*optional*, defaults to ``false``) *boolean* |
| ``lcores`` | | (*optional*, defaults to 1 if not used) *string* – Comma-separated list of logical |
| | | cores to use. An empty string means use all lcores except core 0. core 0 is used |
| | | only when explicitly specified |
| | |
| | Indicates whether DPDK should use only the first physical core or not. |
| | **Example**: ``1,2,3,4,5,18-22`` |
+-----------------------+---------------------------------------------------------------------------------------+
| ``memory_channels`` | (*optional*, defaults to 1) *integer* |
| | |
Expand Down Expand Up @@ -617,4 +603,4 @@ And they both have two network ports which are physically connected to each othe

.. literalinclude:: ../../../dts/conf.yaml
:language: yaml
:start-at: test_runs:
:start-at: test_runs:

0 comments on commit 0f64459

Please sign in to comment.