[dpdk-dev] [PATCH v4 03/22] event/dlb: add private data structures and constants

[Eads, Gage]

> +/*!
> + * Configure the token pop mode for an DLB port. By default, all ports use
> + * AUTO_POP. This function must be called before calling
> rte_event_port_setup()
> + * for the port, but after calling rte_event_dev_configure().
> + *
> + * @note
> + *    The defer_sched vdev arg, which configures all load-balanced ports with
> + *    dequeue_depth == 1 for DEFERRED_POP mode, takes precedence over this
> + *    function.
> + *
> + * @param dev_id
> + *    The identifier of the event device.
> + * @param port_id
> + *    The identifier of the event port.
> + * @param mode
> + *    The token pop mode.
> + *
> + * @return
> + * - 0: Success
> + * - EINVAL: Invalid dev_id, port_id, or mode
> + * - EINVAL: The DLB is not configured, is already running, or the port is
> + *   already setup
> + */

Experimental functions need this at the top of their documentation comment:

 * @warning
 * @b EXPERIMENTAL: this API may change without prior notice.
 *

Thanks,
Gage