/*-
 *   BSD LICENSE
 *
 *   Copyright(c) 2016 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 __INCLUDE_RTE_PORT_FD_H__
#define __INCLUDE_RTE_PORT_FD_H__

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @file
 * RTE Port FD Device
 *
 * fd_reader: input port built on top of valid non-blocking file descriptor
 * fd_writer: output port built on top of valid non-blocking file descriptor
 *
 ***/

#include <stdint.h>

#include <rte_mempool.h>
#include "rte_port.h"

/** fd_reader port parameters */
struct rte_port_fd_reader_params {
	/** File descriptor */
	int fd;

	/** Maximum Transfer Unit (MTU) */
	uint32_t mtu;

	/** Pre-initialized buffer pool */
	struct rte_mempool *mempool;
};

/** fd_reader port operations */
extern struct rte_port_in_ops rte_port_fd_reader_ops;

/** fd_writer port parameters */
struct rte_port_fd_writer_params {
	/** File descriptor */
	int fd;

	/**< Recommended write burst size. The actual burst size can be
	 * bigger or smaller than this value.
	 */
	uint32_t tx_burst_sz;
};

/** fd_writer port operations */
extern struct rte_port_out_ops rte_port_fd_writer_ops;

/** fd_writer_nodrop port parameters */
struct rte_port_fd_writer_nodrop_params {
	/** File descriptor */
	int fd;

	/**< Recommended write burst size. The actual burst size can be
	 * bigger or smaller than this value.
	 */
	uint32_t tx_burst_sz;

	/** Maximum number of retries, 0 for no limit */
	uint32_t n_retries;
};

/** fd_writer_nodrop port operations */
extern struct rte_port_out_ops rte_port_fd_writer_nodrop_ops;

#ifdef __cplusplus
}
#endif

#endif