rte_ethdev_driver.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright(c) 2017 Intel Corporation
 */

#ifndef _RTE_ETHDEV_DRIVER_H_
#define _RTE_ETHDEV_DRIVER_H_

#include <rte_ethdev.h>

#ifdef __cplusplus
extern "C" {
#endif

#define RTE_ETH_QUEUE_STATE_STOPPED 0
#define RTE_ETH_QUEUE_STATE_STARTED 1
#define RTE_ETH_QUEUE_STATE_HAIRPIN 2

int rte_eth_dev_is_rx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);

int rte_eth_dev_is_tx_hairpin_queue(struct rte_eth_dev *dev, uint16_t queue_id);

struct rte_eth_dev *rte_eth_dev_allocated(const char *name);

struct rte_eth_dev *rte_eth_dev_allocate(const char *name);

struct rte_eth_dev *rte_eth_dev_attach_secondary(const char *name);

int rte_eth_dev_release_port(struct rte_eth_dev *eth_dev);

void _rte_eth_dev_reset(struct rte_eth_dev *dev);

int _rte_eth_dev_callback_process(struct rte_eth_dev *dev,
        enum rte_eth_event_type event, void *ret_param);

void rte_eth_dev_probing_finish(struct rte_eth_dev *dev);

const struct rte_memzone *
rte_eth_dma_zone_reserve(const struct rte_eth_dev *eth_dev, const char *name,
             uint16_t queue_id, size_t size,
             unsigned align, int socket_id);

__rte_internal
int
rte_eth_dma_zone_free(const struct rte_eth_dev *eth_dev, const char *name,
         uint16_t queue_id);

static inline int
rte_eth_linkstatus_set(struct rte_eth_dev *dev,
               const struct rte_eth_link *new_link)
{
    volatile uint64_t *dev_link
         = (volatile uint64_t *)&(dev->data->dev_link);
    union {
        uint64_t val64;
        struct rte_eth_link link;
    } orig;

    RTE_BUILD_BUG_ON(sizeof(*new_link) != sizeof(uint64_t));

    orig.val64 = rte_atomic64_exchange(dev_link,
                       *(const uint64_t *)new_link);

    return (orig.link.link_status == new_link->link_status) ? -1 : 0;
}

static inline void
rte_eth_linkstatus_get(const struct rte_eth_dev *dev,
               struct rte_eth_link *link)
{
    volatile uint64_t *src = (uint64_t *)&(dev->data->dev_link);
    uint64_t *dst = (uint64_t *)link;

    RTE_BUILD_BUG_ON(sizeof(*link) != sizeof(uint64_t));

#ifdef __LP64__
    /* if cpu arch has 64 bit unsigned lon then implicitly atomic */
    *dst = *src;
#else
    /* can't use rte_atomic64_read because it returns signed int */
    do {
        *dst = *src;
    } while (!rte_atomic64_cmpset(src, *dst, *dst));
#endif
}

__rte_experimental
int
rte_eth_switch_domain_alloc(uint16_t *domain_id);

__rte_experimental
int
rte_eth_switch_domain_free(uint16_t domain_id);

struct rte_eth_devargs {
    uint16_t ports[RTE_MAX_ETHPORTS];
    uint16_t nb_ports;
    uint16_t representor_ports[RTE_MAX_ETHPORTS];
    uint16_t nb_representor_ports;
};

__rte_experimental
int
rte_eth_devargs_parse(const char *devargs, struct rte_eth_devargs *eth_devargs);


typedef int (*ethdev_init_t)(struct rte_eth_dev *ethdev, void *init_params);
typedef int (*ethdev_bus_specific_init)(struct rte_eth_dev *ethdev,
    void *bus_specific_init_params);

__rte_experimental
int
rte_eth_dev_create(struct rte_device *device, const char *name,
    size_t priv_data_size,
    ethdev_bus_specific_init bus_specific_init, void *bus_init_params,
    ethdev_init_t ethdev_init, void *init_params);


typedef int (*ethdev_uninit_t)(struct rte_eth_dev *ethdev);

__rte_experimental
int
rte_eth_dev_destroy(struct rte_eth_dev *ethdev, ethdev_uninit_t ethdev_uninit);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_ETHDEV_DRIVER_H_ */