[dpdk-dev] [PATCH v4 17/41] doc: add NXP DPAA PMD documentation

[Shreyansh Jain]

On Monday 18 September 2017 08:23 PM, Ferruh Yigit wrote:
> On 9/9/2017 12:21 PM, Shreyansh Jain wrote:
>> Signed-off-by: Hemant Agrawal <hemant.agrawal at nxp.com>
>> Signed-off-by: Shreyansh Jain <shreyansh.jain at nxp.com>
> 
> <...>
> 
>> +Config File Options
>> +~~~~~~~~~~~~~~~~~~~
>> +
>> +The following options can be modified in the ``config`` file.
>> +Please note that enabling debugging options may affect system performance.
>> +
>> +- ``CONFIG_RTE_LIBRTE_DPAA_BUS`` (default ``n``)
>> +
>> +  By default it is enabled only for defconfig_arm64-dpaa-* config.
>> +  Toggle compilation of the ``librte_bus_dpaa`` driver.
>> +
>> +- ``CONFIG_RTE_LIBRTE_DPAA_PMD`` (default ``n``)
>> +
>> +  By default it is enabled only for defconfig_arm64-dpaa-* config.
>> +  Toggle compilation of the ``librte_pmd_dpaa`` driver.
>> +
>> +- ``CONFIG_RTE_LIBRTE_DPAA_DEBUG_DRIVER`` (default ``n``)
>> +
>> +  Toggle display of generic debugging messages
>> +
>> +- ``CONFIG_RTE_LIBRTE_DPAA_DEBUG_INIT`` (default ``n``)
>> +
>> +  Toggle display of initialization related messages.
>> +
>> +- ``CONFIG_RTE_MBUF_DEFAULT_MEMPOOL_OPS`` (default ``dpaa``)
> 
> There are a few new config missing in documentation.

Those are some non-documented/hidden toggles which I don't want to 
expose. Like *CHECKING. They are there only so that some deep debugging 
can be done - which would not be useful for someone not used to the base 
code.

Now that you have highlighted, I will see if we can entirely remove 
those non-documented toggles.

> 
>> +
>> +  This is not a DPAA specific configuration - it is a generic RTE config.
>> +  For optimal performance and hardware utilization, it is expected that DPAA
>> +  Mempool driver is used for mempools. For that, this configuration needs to
>> +  enabled.
>> +
>> +Environment Variables
>> +~~~~~~~~~~~~~~~~~~~~~
>> +
>> +DPAA drivers uses the following environment variables to configure its
>> +state during application initialization:
>> +
>> +- ``DPAA_NUM_RX_QUEUES`` (default 1)
> 
> Why not getting this value as device arg?

We had this discussion during DPAA2 as well. This time, I was not sure 
of how the device argument patches are turning out to be after the 
re-shuffle being done by Gaetan. So, I kept this as it is.

> 
> <...>
> 
>