rte_devargs.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2014 6WIND S.A.
 */

#ifndef _RTE_DEVARGS_H_
#define _RTE_DEVARGS_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdio.h>
#include <sys/queue.h>
#include <rte_compat.h>
#include <rte_bus.h>

#define RTE_DEVARGS_KEY_BUS "bus"

#define RTE_DEVARGS_KEY_CLASS "class"

#define RTE_DEVARGS_KEY_DRIVER "driver"

enum rte_devtype {
    RTE_DEVTYPE_ALLOWED,
    RTE_DEVTYPE_BLOCKED,
    RTE_DEVTYPE_VIRTUAL,
};

/* Backwards compatibility will be removed later */
#define RTE_DEVTYPE_WHITELISTED_PCI \
    RTE_DEPRECATED(RTE_DEVTYPE_WHITELISTED_PCI) RTE_DEVTYPE_ALLOWED
#define RTE_DEVTYPE_BLACKLISTED_PCI \
    RTE_DEPRECATED(RTE_DEVTYPE_BLACKLISTED_PCI) RTE_DEVTYPE_BLOCKED

struct rte_devargs {
    TAILQ_ENTRY(rte_devargs) next;
    enum rte_devtype type;
    enum rte_dev_policy policy;
    char name[RTE_DEV_NAME_MAX_LEN];
    RTE_STD_C11
    union {
        const char *args; 
        const char *drv_str; 
    };
    struct rte_bus *bus; 
    struct rte_class *cls; 
    const char *bus_str; 
    const char *cls_str; 
    char *data; 
};

int
rte_devargs_parse(struct rte_devargs *da, const char *dev);

int
rte_devargs_parsef(struct rte_devargs *da,
           const char *format, ...)
__rte_format_printf(2, 0);

__rte_experimental
void
rte_devargs_reset(struct rte_devargs *da);

int
rte_devargs_insert(struct rte_devargs **da);

int rte_devargs_add(enum rte_devtype devtype, const char *devargs_str);

int rte_devargs_remove(struct rte_devargs *devargs);

unsigned int
rte_devargs_type_count(enum rte_devtype devtype);

void rte_devargs_dump(FILE *f);

struct rte_devargs *
rte_devargs_next(const char *busname, const struct rte_devargs *start);

#define RTE_EAL_DEVARGS_FOREACH(busname, da) \
    for (da = rte_devargs_next(busname, NULL); \
         da != NULL; \
         da = rte_devargs_next(busname, da)) \

#ifdef __cplusplus
}
#endif

#endif /* _RTE_DEVARGS_H_ */