eth_rxq_common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2023 NVIDIA CORPORATION AND AFFILIATES.  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 the NVIDIA 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 NVIDIA CORPORATION 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 TOR (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 ETH_RXQ_COMMON_H_
#define ETH_RXQ_COMMON_H_
 
#include <unistd.h>
 
#include <doca_flow.h>
#include <doca_dev.h>
#include <doca_error.h>
#include <doca_buf.h>
 
struct eth_rxq_flow_resources {
    struct doca_flow_port *df_port;      /* DOCA flow port */
    struct doca_flow_pipe *root_pipe;    /* DOCA flow root pipe*/
    struct doca_flow_pipe_entry *root_entry; /* DOCA flow root pipe entry*/
};
 
struct eth_rxq_flow_config {
    struct doca_dev *dev;         /* DOCA device */
    uint16_t *rxq_flow_queue_ids; /* DOCA ETH RXQ's flow queue IDs */
    uint16_t nb_queues;       /* Number of DOCA FLOW queues wanted */
};
 
/*
 * Initializes DOCA flow for ETH RXQ sample
 *
 * @dev [in]: Doca device to use for doca_flow_port
 * @resources [in]: flow resources
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t rxq_common_init_doca_flow(struct doca_dev *dev, struct eth_rxq_flow_resources *resources);
 
/*
 * Allocate DOCA flow resources for ETH RXQ sample
 *
 * @cfg [in]: Configuration parameters
 * @resources [out]: DOCA flow resources for ETH RXQ sample to allocate
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t allocate_eth_rxq_flow_resources(struct eth_rxq_flow_config *cfg, struct eth_rxq_flow_resources *resources);
 
/*
 * Destroy DOCA flow resources for ETH RXQ sample
 *
 * @resources [in]: DOCA flow resources for ETH RXQ sample to destroy
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t destroy_eth_rxq_flow_resources(struct eth_rxq_flow_resources *resources);
 
/*
 * Get DOCA buf packet headroom size for ETH RXQ sample
 *
 * @pkt [in]: DOCA buf packet for ETH RXQ
 * @headroom_size [out]: packet headroom size
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t get_pkt_headroom(struct doca_buf *pkt, uint16_t *headroom_size);
 
/*
 * Get DOCA buf packet tailroom size for ETH RXQ sample
 *
 * @pkt [in]: DOCA buf packet for ETH RXQ
 * @tailroom_size [out]: packet tailroom size
 * @return: DOCA_SUCCESS on success and DOCA_ERROR otherwise
 */
doca_error_t get_pkt_tailroom(struct doca_buf *pkt, uint16_t *tailroom_size);
 
#endif /* ETH_RXQ_COMMON_H_ */