rte_rawdev.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2017 NXP
 */

#ifndef _RTE_RAWDEV_H_
#define _RTE_RAWDEV_H_

#include <rte_common.h>
#include <rte_memory.h>

#ifdef __cplusplus
extern "C" {
#endif

/* Rawdevice object - essentially a void to be typecast by implementation */
typedef void *rte_rawdev_obj_t;

uint8_t
rte_rawdev_count(void);

uint16_t
rte_rawdev_get_dev_id(const char *name);

int
rte_rawdev_socket_id(uint16_t dev_id);

struct rte_rawdev_info;

int
rte_rawdev_info_get(uint16_t dev_id, struct rte_rawdev_info *dev_info,
        size_t dev_private_size);

int
rte_rawdev_configure(uint16_t dev_id, struct rte_rawdev_info *dev_conf,
        size_t dev_private_size);


int
rte_rawdev_queue_conf_get(uint16_t dev_id,
              uint16_t queue_id,
              rte_rawdev_obj_t queue_conf,
              size_t queue_conf_size);

int
rte_rawdev_queue_setup(uint16_t dev_id,
               uint16_t queue_id,
               rte_rawdev_obj_t queue_conf,
               size_t queue_conf_size);

int
rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id);

uint16_t
rte_rawdev_queue_count(uint16_t dev_id);

int
rte_rawdev_start(uint16_t dev_id);

void
rte_rawdev_stop(uint16_t dev_id);

int
rte_rawdev_close(uint16_t dev_id);

int
rte_rawdev_reset(uint16_t dev_id);

#define RTE_RAWDEV_NAME_MAX_LEN (64)

struct __rte_cache_aligned rte_rawdev {
    int socket_id;
    uint16_t dev_id;
    const struct rte_rawdev_ops *dev_ops;
    struct rte_device *device;
    const char *driver_name;

    uint8_t attached : 1;
    uint8_t started : 1;

    rte_rawdev_obj_t dev_private;
    char name[RTE_RAWDEV_NAME_MAX_LEN];
};

extern struct rte_rawdev *rte_rawdevs;


struct rte_rawdev_info {
    const char *driver_name;
    struct rte_device *device;
    int socket_id;
    rte_rawdev_obj_t dev_private;
};

struct rte_rawdev_buf {
    void *buf_addr;
};

int
rte_rawdev_dump(uint16_t dev_id, FILE *f);

int
rte_rawdev_get_attr(uint16_t dev_id,
            const char *attr_name,
            uint64_t *attr_value);

int
rte_rawdev_set_attr(uint16_t dev_id,
            const char *attr_name,
            const uint64_t attr_value);

int
rte_rawdev_enqueue_buffers(uint16_t dev_id,
               struct rte_rawdev_buf **buffers,
               unsigned int count,
               rte_rawdev_obj_t context);

int
rte_rawdev_dequeue_buffers(uint16_t dev_id,
               struct rte_rawdev_buf **buffers,
               unsigned int count,
               rte_rawdev_obj_t context);

#define RTE_RAW_DEV_XSTATS_NAME_SIZE 64

struct rte_rawdev_xstats_name {
    char name[RTE_RAW_DEV_XSTATS_NAME_SIZE];
};

int
rte_rawdev_xstats_names_get(uint16_t dev_id,
                struct rte_rawdev_xstats_name *xstats_names,
                unsigned int size);

int
rte_rawdev_xstats_get(uint16_t dev_id,
              const unsigned int ids[],
              uint64_t values[],
              unsigned int n);

uint64_t
rte_rawdev_xstats_by_name_get(uint16_t dev_id,
                  const char *name,
                  unsigned int *id);

int
rte_rawdev_xstats_reset(uint16_t dev_id,
            const uint32_t ids[],
            uint32_t nb_ids);

int
rte_rawdev_firmware_status_get(uint16_t dev_id,
                   rte_rawdev_obj_t status_info);

int
rte_rawdev_firmware_version_get(uint16_t dev_id,
                rte_rawdev_obj_t version_info);

int
rte_rawdev_firmware_load(uint16_t dev_id, rte_rawdev_obj_t firmware_image);

int
rte_rawdev_firmware_unload(uint16_t dev_id);

int
rte_rawdev_selftest(uint16_t dev_id);

#ifdef __cplusplus
}
#endif

#endif /* _RTE_RAWDEV_H_ */