From: "Mokhtar, Amr" <amr.mokhtar@intel.com>
To: "Kovacevic, Marko" <marko.kovacevic@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "thomas@monjalon.net" <thomas@monjalon.net>,
"Burakov, Anatoly" <anatoly.burakov@intel.com>,
"De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>,
"Power, Niall" <niall.power@intel.com>,
"Macnamara, Chris" <chris.macnamara@intel.com>
Subject: Re: [dpdk-dev] [PATCH v3 5/5] bbdev: documentation
Date: Sat, 23 Dec 2017 00:11:37 +0000 [thread overview]
Message-ID: <3D3765A8CDB52A4C8B410430AA19CB236EC654C6@IRSMSX104.ger.corp.intel.com> (raw)
In-Reply-To: <6DC05C7C5F25994B81B3F2F214251F6632ABEA@IRSMSX104.ger.corp.intel.com>
> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Monday 18 December 2017 14:26
> To: Mokhtar, Amr <amr.mokhtar@intel.com>; dev@dpdk.org
> Cc: thomas@monjalon.net; Burakov, Anatoly <anatoly.burakov@intel.com>; De
> Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Power, Niall
> <niall.power@intel.com>; Macnamara, Chris <chris.macnamara@intel.com>;
> Mokhtar, Amr <amr.mokhtar@intel.com>
> Subject: RE: [dpdk-dev] [PATCH v3 5/5] bbdev: documentation
>
>
>
> > -----Original Message-----
> > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Amr Mokhtar
> > Sent: Thursday, December 7, 2017 9:41 PM
> > To: dev@dpdk.org
> > Cc: thomas@monjalon.net; Burakov, Anatoly <anatoly.burakov@intel.com>;
> De
> > Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Power, Niall
> > <niall.power@intel.com>; Macnamara, Chris <chris.macnamara@intel.com>;
> > Mokhtar, Amr <amr.mokhtar@intel.com>
> > Subject: [dpdk-dev] [PATCH v3 5/5] bbdev: documentation
> >
> > - Wireless Baseband Device Library Programmer’s Guide
> > - test-bbdev User Guide
> > - BBDEV Sample Application User Guides
> > - Baseband Device Drivers Guides
> > - Doxygen API
> >
> > Signed-off-by: Amr Mokhtar <amr.mokhtar@intel.com>
> > ---
> > doc/api/doxy-api-index.md | 1 +
> > doc/api/doxy-api.conf | 1 +
> > doc/guides/bbdevs/index.rst | 40 +++
> > doc/guides/bbdevs/null.rst | 77 +++++
> > doc/guides/bbdevs/turbo_sw.rst | 175 ++++++++++
> > doc/guides/index.rst | 1 +
> > doc/guides/prog_guide/bbdev.rst | 613
> > +++++++++++++++++++++++++++++++++
> > doc/guides/prog_guide/index.rst | 1 +
> > doc/guides/sample_app_ug/bbdev_app.rst | 160 +++++++++
> > doc/guides/sample_app_ug/index.rst | 1 +
> > doc/guides/tools/index.rst | 1 +
> > doc/guides/tools/testbbdev.rst | 600
> > ++++++++++++++++++++++++++++++++
> > 12 files changed, 1671 insertions(+)
> > create mode 100644 doc/guides/bbdevs/index.rst
> > create mode 100644 doc/guides/bbdevs/null.rst
> > create mode 100644 doc/guides/bbdevs/turbo_sw.rst
> > create mode 100644 doc/guides/prog_guide/bbdev.rst
> > create mode 100644 doc/guides/sample_app_ug/bbdev_app.rst
> > create mode 100644 doc/guides/tools/testbbdev.rst
> >
> > diff --git a/doc/api/doxy-api-index.md b/doc/api/doxy-api-index.md
> > index 3492702..8d7ff89 100644
> > --- a/doc/api/doxy-api-index.md
> > +++ b/doc/api/doxy-api-index.md
> > @@ -50,6 +50,7 @@ The public API headers are grouped by topics:
> > [bitrate] (@ref rte_bitrate.h),
> > [latency] (@ref rte_latencystats.h),
> > [devargs] (@ref rte_devargs.h),
> > + [bbdev] (@ref rte_bbdev.h),
> > [PCI] (@ref rte_pci.h)
> >
> > - **device specific**:
> > diff --git a/doc/api/doxy-api.conf b/doc/api/doxy-api.conf
> > index b2cbe94..241cae3 100644
> > --- a/doc/api/doxy-api.conf
> > +++ b/doc/api/doxy-api.conf
> > @@ -39,6 +39,7 @@ INPUT = doc/api/doxy-api-index.md \
> > lib/librte_eal/common/include \
> > lib/librte_eal/common/include/generic \
> > lib/librte_acl \
> > + lib/librte_bbdev \
> > lib/librte_bitratestats \
> > lib/librte_cfgfile \
> > lib/librte_cmdline \
> > diff --git a/doc/guides/bbdevs/index.rst b/doc/guides/bbdevs/index.rst
<..>
> > +* Build the ``FLEXRAN SDK`` libraries (explained in Installation section).
> > +
> > +* Export the environmental variables ``FLEXRAN_SDK`` to the path where the
> > + FlexRAN SDK libraries were installed. And ``DIR_WIRELESS_SDK`` to the path
> > + where the librararies were extracted.
>
> Typo above librararies/ libraries
>
>
> > +Input and output data buffers are identified by ``rte_bbdev_op_data``
> > structure.
> > +This strucutre has three elements:
>
> Typo above strucutre / structure
>
>
>
> > +Limitations
> > +-----------
> > +
> > +* Although, the baseband sample application is designed to work in full-
> duplex
> > + mode, but due to theplain format of the received packets from pkt-gen, the
> > + Turbo decode (uplink) is not operable. Only the Turbo encode direction
> > + (downlink) is currently supported in the bbdev sample application.
>
> Small space required theplain/ the plain
>
>
>
> > +where, NIC0PCIADDR is the PCI addresse of the Rx port
>
> Typo addresse/ address
>
>
> > +Test Vector files
> > +=================
> > +
> > +Test Vector files contain the data which is used to set turbo decoder/encoder
> > +parameters and buffers for validation purpose. New test vector files should
> be
> > +stored in ``app/test-bbdev/test_vectors/`` directory. Detailed description of
> > +the systax of the test vector files is in the following section.
>
> Typo systax/ syntax
>
>
> Marko Kovacevic
Thanks Marko. All typos were fixed.
next prev parent reply other threads:[~2017-12-23 0:11 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-12-07 21:40 [dpdk-dev] [PATCH v3 1/5] bbdev: librte_bbdev library Amr Mokhtar
2017-12-07 21:40 ` [dpdk-dev] [PATCH v3 2/5] bbdev: PMD drivers (null/turbo_sw) Amr Mokhtar
2017-12-11 19:00 ` Ferruh Yigit
2017-12-19 19:09 ` Mokhtar, Amr
2017-12-07 21:40 ` [dpdk-dev] [PATCH v3 3/5] bbdev: test applications Amr Mokhtar
2017-12-11 19:01 ` Ferruh Yigit
2017-12-23 0:09 ` Mokhtar, Amr
2017-12-07 21:40 ` [dpdk-dev] [PATCH v3 4/5] bbdev: sample app Amr Mokhtar
2017-12-07 21:40 ` [dpdk-dev] [PATCH v3 5/5] bbdev: documentation Amr Mokhtar
2017-12-11 19:01 ` Ferruh Yigit
2017-12-19 19:34 ` Mokhtar, Amr
2017-12-18 14:26 ` Kovacevic, Marko
2017-12-23 0:11 ` Mokhtar, Amr [this message]
2017-12-07 21:40 ` [dpdk-dev] [PATCH v3 0/5] Wireless Baseband Device (bbdev) Amr Mokhtar
2017-12-09 2:44 ` [dpdk-dev] [PATCH v3 1/5] bbdev: librte_bbdev library Ferruh Yigit
2017-12-19 19:03 ` Mokhtar, Amr
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=3D3765A8CDB52A4C8B410430AA19CB236EC654C6@IRSMSX104.ger.corp.intel.com \
--to=amr.mokhtar@intel.com \
--cc=anatoly.burakov@intel.com \
--cc=chris.macnamara@intel.com \
--cc=dev@dpdk.org \
--cc=marko.kovacevic@intel.com \
--cc=niall.power@intel.com \
--cc=pablo.de.lara.guarch@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).