[dpdk-dev] [PATCH 3/7] ethdev: separate driver APIs

[Shreyansh Jain]

Hello Ferruh,

(Somehow it seems that patch was not delivered to dev at dpdk ML).
One comment below:

<Snip>
[] 
> 
> There is no update in header content and since ethdev.h included by
> ethdev_driver.h, nothing changed from driver point of view, only
> logically grouping of APIs. From applications point of view they can't
> access to driver specific APIs anymore and they shouldn't.
> 
> More PMD specific data structures still remain in ethdev.h because of
> inline functions in header use them. Those will be handled separately.

+1 

> 
> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>
> ---

[...]

> diff --git a/drivers/bus/dpaa/include/fman.h
> b/drivers/bus/dpaa/include/fman.h
> index 9890e09ce..fec154545 100644
> --- a/drivers/bus/dpaa/include/fman.h
> +++ b/drivers/bus/dpaa/include/fman.h
> @@ -44,7 +44,7 @@
>  #include <stdbool.h>
>  #include <net/if.h>
> 
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
>  #include <rte_ether.h>
> 
>  #include <compat.h>
> diff --git a/drivers/bus/fslmc/fslmc_bus.c b/drivers/bus/fslmc/fslmc_bus.c
> index 480857e57..8f4993f3a 100644
> --- a/drivers/bus/fslmc/fslmc_bus.c
> +++ b/drivers/bus/fslmc/fslmc_bus.c
> @@ -40,7 +40,7 @@
>  #include <rte_malloc.h>
>  #include <rte_devargs.h>
>  #include <rte_memcpy.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
> 
>  #include <rte_fslmc.h>
>  #include <fslmc_vfio.h>
> diff --git a/drivers/bus/fslmc/fslmc_vfio.c b/drivers/bus/fslmc/fslmc_vfio.c
> index 7831201ad..eec5cdd94 100644
> --- a/drivers/bus/fslmc/fslmc_vfio.c
> +++ b/drivers/bus/fslmc/fslmc_vfio.c
> @@ -48,7 +48,7 @@
> 
>  #include <eal_filesystem.h>
>  #include <rte_mbuf.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
>  #include <rte_malloc.h>
>  #include <rte_memcpy.h>
>  #include <rte_string_fns.h>
> diff --git a/drivers/bus/fslmc/portal/dpaa2_hw_dpbp.c
> b/drivers/bus/fslmc/portal/dpaa2_hw_dpbp.c
> index 334e1f5ad..55c38fd8d 100644
> --- a/drivers/bus/fslmc/portal/dpaa2_hw_dpbp.c
> +++ b/drivers/bus/fslmc/portal/dpaa2_hw_dpbp.c
> @@ -45,7 +45,7 @@
>  #include <rte_cycles.h>
>  #include <rte_kvargs.h>
>  #include <rte_dev.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
> 
>  #include <fslmc_logs.h>
>  #include <rte_fslmc.h>
> diff --git a/drivers/bus/fslmc/portal/dpaa2_hw_dpci.c
> b/drivers/bus/fslmc/portal/dpaa2_hw_dpci.c
> index ae189c72a..7a86d047a 100644
> --- a/drivers/bus/fslmc/portal/dpaa2_hw_dpci.c
> +++ b/drivers/bus/fslmc/portal/dpaa2_hw_dpci.c
> @@ -44,7 +44,7 @@
>  #include <rte_cycles.h>
>  #include <rte_kvargs.h>
>  #include <rte_dev.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
> 
>  #include <fslmc_logs.h>
>  #include <rte_fslmc.h>
> diff --git a/drivers/bus/fslmc/portal/dpaa2_hw_dpio.c
> b/drivers/bus/fslmc/portal/dpaa2_hw_dpio.c
> index f00070f3f..6a6c8c3b6 100644
> --- a/drivers/bus/fslmc/portal/dpaa2_hw_dpio.c
> +++ b/drivers/bus/fslmc/portal/dpaa2_hw_dpio.c
> @@ -50,7 +50,7 @@
>  #include<sys/eventfd.h>
> 
>  #include <rte_mbuf.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
>  #include <rte_malloc.h>
>  #include <rte_memcpy.h>
>  #include <rte_string_fns.h>
> diff --git a/drivers/event/dpaa2/dpaa2_eventdev.c
> b/drivers/event/dpaa2/dpaa2_eventdev.c
> index eeeb23127..a20a556d4 100644
> --- a/drivers/event/dpaa2/dpaa2_eventdev.c
> +++ b/drivers/event/dpaa2/dpaa2_eventdev.c
> @@ -52,7 +52,7 @@
>  #include <rte_memory.h>
>  #include <rte_pci.h>
>  #include <rte_bus_vdev.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
>  #include <rte_event_eth_rx_adapter.h>
> 
>  #include <fslmc_vfio.h>
> diff --git a/drivers/event/dpaa2/dpaa2_hw_dpcon.c
> b/drivers/event/dpaa2/dpaa2_hw_dpcon.c
> index 005e6234d..a8da9803b 100644
> --- a/drivers/event/dpaa2/dpaa2_hw_dpcon.c
> +++ b/drivers/event/dpaa2/dpaa2_hw_dpcon.c
> @@ -44,7 +44,7 @@
>  #include <rte_cycles.h>
>  #include <rte_kvargs.h>
>  #include <rte_dev.h>
> -#include <rte_ethdev.h>
> +#include <rte_ethdev_driver.h>
> 
>  #include <rte_fslmc.h>
>  #include <mc/fsl_dpcon.h>

With respect to DPAA and DPAA2 and overall aim of patch:

Acked-by: Shreyansh Jain <shreyansh.jain at nxp.com>

[...]

> diff --git a/lib/librte_ether/rte_ethdev_driver.h
> b/lib/librte_ether/rte_ethdev_driver.h
> new file mode 100644
> index 000000000..3e77d1439
> --- /dev/null
> +++ b/lib/librte_ether/rte_ethdev_driver.h
> @@ -0,0 +1,163 @@
> +/*-
> + *   BSD LICENSE
> + *
> + *   Copyright(c) 2017 Intel Corporation. All rights reserved.
> + *   All rights reserved.
> + *
> + *   Redistribution and use in source and binary forms, with or without
> + *   modification, are permitted provided that the following conditions
> + *   are met:
> + *
> + *     * Redistributions of source code must retain the above copyright
> + *       notice, this list of conditions and the following disclaimer.
> + *     * Redistributions in binary form must reproduce the above copyright
> + *       notice, this list of conditions and the following disclaimer in
> + *       the documentation and/or other materials provided with the
> + *       distribution.
> + *     * Neither the name of Intel Corporation nor the names of its
> + *       contributors may be used to endorse or promote products derived
> + *       from this software without specific prior written permission.
> + *
> + *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
> + *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
> + *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
> + *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
> + *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
> + *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
> + *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
> + *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
> + *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
> + *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
> + *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
> + */
> +
> +#ifndef _RTE_ETHDEV_DRIVER_H_
> +#define _RTE_ETHDEV_DRIVER_H_

Now that it is almost agreed to move towards SPDX based licensing text [1][2], and this new file is being introduced - do you think it makes sense to do it for this file?

[1] http://dpdk.org/ml/archives/dev/2017-November/082382.html
[2] http://dpdk.org/ml/archives/dev/2017-November/082639.html

[...]