[dpdk-dev] [PATCH v3 5/5] bbdev: documentation

[Mokhtar, Amr]

> -----Original Message-----
> From: Kovacevic, Marko
> Sent: Monday 18 December 2017 14:26
> To: Mokhtar, Amr <amr.mokhtar at intel.com>; dev at dpdk.org
> Cc: thomas at monjalon.net; Burakov, Anatoly <anatoly.burakov at intel.com>; De
> Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>; Power, Niall
> <niall.power at intel.com>; Macnamara, Chris <chris.macnamara at intel.com>;
> Mokhtar, Amr <amr.mokhtar at intel.com>
> Subject: RE: [dpdk-dev] [PATCH v3 5/5] bbdev: documentation
> 
> 
> 
> > -----Original Message-----
> > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Amr Mokhtar
> > Sent: Thursday, December 7, 2017 9:41 PM
> > To: dev at dpdk.org
> > Cc: thomas at monjalon.net; Burakov, Anatoly <anatoly.burakov at intel.com>;
> De
> > Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>; Power, Niall
> > <niall.power at intel.com>; Macnamara, Chris <chris.macnamara at intel.com>;
> > Mokhtar, Amr <amr.mokhtar at 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 at 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.