Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Jhalackova pf bb config #378

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Jhalackova pf bb config #378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
7ec250a
Added pf-bb-config installation.
lvicoun Oct 21, 2024
c5ace17
Added pf_bb_config usage.
lvicoun Oct 22, 2024
55095d8
Added configuration details.
lvicoun Oct 24, 2024
286e3ca
Maek it buildable.
lvicoun Oct 25, 2024
94ba9d1
Fixed the tool name.
lvicoun Oct 25, 2024
ffc9d22
Added enabling the vfio-pci driver.
lvicoun Oct 29, 2024
77d9970
Finalize the article.
lvicoun Oct 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions DC-Micro-pf_bb_config
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# This file originates from the project https://github.com/openSUSE/doc-kit
# This file can be edited downstream.

MAIN="pf-bb-config.asm.xml"
# Point to the ID of the <structure> of your assembly
ROOTID="pf-bb-config"
SRC_DIR="articles"
IMG_SRC_DIR="images"

PROFOS="slmicro"
#PROFCONDITION="suse-product;beta"
#PROFCONDITION="community-project"

STYLEROOT="/usr/share/xml/docbook/stylesheet/suse2022-ns"
FALLBACK_STYLEROOT="/usr/share/xml/docbook/stylesheet/suse-ns"
222 changes: 222 additions & 0 deletions articles/pf-bb-config.asm.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,222 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE assembly
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<assembly version="5.2" xml:lang="en"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns="http://docbook.org/ns/docbook">
<!-- resources section references all topic chunks used in the final article
-->
<!-- R E S O U R C E S -->

<!-- Concept files -->
<resources>
<resource xml:id="_pf-bb-config-terminology" href="../concepts/pf-bb-config-terminology.xml">
<description>About the tool</description>
</resource>
</resources>
<!-- Tasks -->
<resources>
<resource xml:id="_pf-bb-config-installation" href="../tasks/pf-bb-config-installation.xml">
<description>Installing pf_bb_config</description>
</resource>
<resource xml:id="_pf-bb-config-vfio" href="../tasks/pf-bb-config-vfio.xml">
<description>Enabling the vfio-pci driver</description>
</resource>
</resources>
<!-- References -->
<resources>
<resource xml:id="_pf-bb-config-usage" href="../references/pf-bb-config-usage.xml">
<description>Usage</description>
</resource>
<resource xml:id="_pf-bb-config-configuration-examples" href="../references/pf-bb-config-configuration-examples.xml">
<description>Configuration description</description>
</resource>
</resources>
<!-- Legal -->
<resources>
<resource href="../common/legal.xml" xml:id="_legal">
<description>Legal Notice</description>
</resource>
<resource href="../common/license_gfdl1.2.xml" xml:id="_gfdl">
<description>GNU Free Documentation License</description>
</resource>
</resources>
<!-- S T R U C T U R E -->
<structure renderas="article" xml:id="pf-bb-config" xml:lang="en">
<merge>
<title>The Physical Function Baseband Device Configuration Using <literal>pf_bb_config</literal></title>
<!-- Create revision history to enable versioning; add most recent entries at the top. -->
<!-- Check https://documentation.suse.com/style/current/single-html/docu_styleguide/#sec-revhistory for detailed instructions-->
<revhistory xml:id="rh-pf-bb-config">
<revision><date>2024-11-05</date>
<revdescription>
<itemizedlist>
<!-- Group by type of change (added/removed/changed)-->
<listitem><para>Initial version</para>
</listitem>
</itemizedlist>
</revdescription>
</revision>
</revhistory>
<!-- TODO: provide a listing of possible and validatable meta entry values. Maybe in our geekodoc repo? -->
<!-- add author's e-mail -->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<!-- ISO date of last update as YYYY-MM-DD -->
<meta name="updated" content="2024-11-16" its:translate="no"/>
<!-- this does not work yet. Use the dm tags listed below for now
<meta name="bugtracker" its:translate="no">
<phrase role="url">https://bugzilla.suse.com/enter_bug.cgi</phrase>
<phrase role="component">Non-product-specific documentation</phrase>
<phrase role="product">Smart Docs</phrase>
<phrase role="assignee">[email protected]</phrase>
</meta>
-->
<!-- not supported, yet. Use dm: tag for now
<meta name="translation" its:translate="no">
<phrase role="trans">yes</phrase>
<phrase role="language">de-de,cs-cz</phrase>
</meta>
-->
<!-- enter the platform identifier or a list of
identifiers, separated by ; -->
<!-- For a full list of meta tags and their values,
see https://confluence.suse.com/x/aQDWNg
-->
<meta name="architecture">
<phrase>&x86-64;</phrase>
</meta>
<!-- enter one or more product names and version -->
<meta name="productname" its:translate="no">
<productname version="6.1">&slm;</productname>
</meta>
<meta name="title" its:translate="yes">pf_bb_config&mdash;the tool to configure broadband devices</meta>
<meta name="description" its:translate="yes">Configuration of physica functions of broadband
device using <literal>pf_bb_config</literal></meta>
<meta name="social-descr" its:translate="yes">Configuration of physica functions of broadband
device using <literal>pf_bb_config</literal></meta>
<!-- suitable categories -->

<!-- Determines "filter by task" filter value -->
<meta name="task">
<phrase>Configuration</phrase>
</meta>
<meta name="series">Products &amp; Solutions</meta>

<dm:docmanager xmlns:dm="urn:x-suse:ns:docmanager">
<dm:bugtracker>
<dm:url>https://bugzilla.suse.com/enter_bug.cgi</dm:url>
<dm:component>Smart Docs</dm:component>
<dm:product>Documentation</dm:product>
<!-- provide your BUGZILLA e-mail address, otherwise this does not work correctly-->
<dm:assignee>[email protected]</dm:assignee>
</dm:bugtracker>
<dm:translation>yes</dm:translation>
</dm:docmanager>
<abstract>
<variablelist>
<varlistentry>
<term>WHAT?</term>
<listitem>
<para>
The <literal>pf_bb_config</literal> is a configuration tool that based on a given
configuration files enables you to configure physical functions of various baseband devices.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>WHY?</term>
<listitem>
<para>
This article focuses on installation and usage of the <literal>pf_bb_config</literal> tool.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>EFFORT</term>
<listitem>
<para>
It takes approximately 10 minutes to read the article.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>GOAL</term>
<listitem>
<para>
You will know howto configure broadband devices and how to enable direct access to
hardware for virtual machines.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>REQUIREMENTS</term>
<listitem>
<itemizedlist>
<listitem>
<para>
A registered running instance of &productname;
</para>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</abstract>
</merge>
<!-- pull in all the topic files you need -->
<!-- pick the appropriate type of include to match your needs -->
<!-- pull in a topic as is -->
<module resourceref="_pf-bb-config-terminology" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<!-- pull in a topic and switch the title -->
<module resourceref="_pf-bb-config-installation" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module resourceref="_pf-bb-config-usage" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>

<module resourceref="_pf-bb-config-vfio" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
<module resourceref="_pf-bb-config-configuration-examples" renderas="section">
<merge>
<abstract>
<para/>
</abstract>
</merge>
</module>
</module>
<module resourceref="_legal"/>
<module resourceref="_gfdl">
<output renderas="appendix"/>
</module>
</structure>
</assembly>
40 changes: 40 additions & 0 deletions concepts/pf-bb-config-terminology.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="pf-bb-config-about"
role="concept" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>What is <literal>pf_bb_config</literal>?</title><!-- can be changed via merge in the assembly -->
<!--add author's email address-->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract><!-- can be changed via merge in the assembly -->
<para>
The topic covers basic information about <literal>pf_bb_config</literal>
</para>
</abstract>
</info>
<para>
<literal>pf_bb_config</literal> is a tool that enables you to configure broadband devices on
your host system. The tool acceses the configuration space and sets parameters using
memory-mapped I/O (MMIO) read and write operations.
</para>
<para>
The particular broadband device configuration parameters are parsed from a passed configuration
file specific to that device.
</para>

</topic>
86 changes: 86 additions & 0 deletions references/pf-bb-config-configuration-examples.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?xml version="1.0" encoding="UTF-8"?>
<!-- This file originates from the project https://github.com/openSUSE/doc-kit -->
<!-- This file can be edited downstream. -->
<!DOCTYPE topic
[
<!ENTITY % entities SYSTEM "../common/generic-entities.ent">
%entities;
]>
<!-- refers to legacy doc: <add github link to legacy doc piece, if applicable> -->
<!-- point back to this document with a similar comment added to your legacy doc piece -->
<!-- refer to README.md for file and id naming conventions -->
<!-- metadata is dealt with on the assembly level -->
<topic xml:id="pf-bb-config-examples"
role="reference" xml:lang="en"
xmlns="http://docbook.org/ns/docbook" version="5.2"
xmlns:its="http://www.w3.org/2005/11/its"
xmlns:xi="http://www.w3.org/2001/XInclude"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:trans="http://docbook.org/ns/transclusion">
<info>
<title>Configuration examples description</title><!-- can be changed via merge in the assembly -->
<!--add author's email address-->
<meta name="maintainer" content="[email protected]" its:translate="no"/>
<abstract><!-- can be changed via merge in the assembly -->
<para>
The topic covers details regarding particular devices configuration.
</para>
</abstract>
</info>
<para>
You can find the broadband devices confiration examples in
<filename>/opt/pf-bb-config</filename>. Each device has a specific set of configuration files,
however, all configuration files follow the same format.
</para>
<screen>
[section name]
key = value
; This is a comment.
</screen>
<para>
The following section
provides details regarding ACC100/ACC200 accelarator.
</para>
<section xml:id="pf-bb-config-examples-acc100">
<title>The ACC100/ACC200 configuration</title>
<para>
In the examples <filename>/opt/pf-bb-config/acc*</filename>, you can adjust the following attributes:
</para>
<variablelist>
<varlistentry>
<term><literal>pf_mode_en</literal></term>
<listitem>
<para>
If set to 1, all queues on the device are assigned to physical function (PF) and none
is assigneg to virtual functions (VF). PF and VF are mutually exclusive.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_qgroups</literal></term>
<listitem>
<para>
There are eight queue groups available that you can allocate to <emphasis>all</emphasis> operations.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_vf_bundles</literal></term>
<listitem>
<para>
Choose value between 1 and 16. The available DDR is then split
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><literal>num_aqs_per_groups</literal></term>
<listitem>
<para>
Defines the maximum count of atomic queues in a single queue group.
</para>
</listitem>
</varlistentry>
</variablelist>

</section>
</topic>
Loading