rte_regexdev_core.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-3-Clause
 * Copyright 2020 Mellanox Technologies, Ltd
 */

#ifndef _RTE_REGEX_CORE_H_
#define _RTE_REGEX_CORE_H_

struct rte_regexdev;

typedef int (*regexdev_info_get_t)(struct rte_regexdev *dev,
                   struct rte_regexdev_info *info);
typedef int (*regexdev_configure_t)(struct rte_regexdev *dev,
                    const struct rte_regexdev_config *cfg);
typedef int (*regexdev_qp_setup_t)(struct rte_regexdev *dev, uint16_t id,
                   const struct rte_regexdev_qp_conf *qp_conf);
typedef int (*regexdev_start_t)(struct rte_regexdev *dev);
typedef int (*regexdev_stop_t)(struct rte_regexdev *dev);
typedef int (*regexdev_close_t)(struct rte_regexdev *dev);
typedef int (*regexdev_attr_get_t)(struct rte_regexdev *dev,
                   enum rte_regexdev_attr_id id,
                   void *value);
typedef int (*regexdev_attr_set_t)(struct rte_regexdev *dev,
                   enum rte_regexdev_attr_id id,
                   const void *value);
typedef int (*regexdev_rule_db_update_t)(struct rte_regexdev *dev,
                     const struct rte_regexdev_rule *rules,
                     uint16_t nb_rules);
typedef int (*regexdev_rule_db_compile_activate_t)(struct rte_regexdev *dev);
typedef int (*regexdev_rule_db_import_t)(struct rte_regexdev *dev,
                     const  char *rule_db,
                     uint32_t rule_db_len);
typedef int (*regexdev_rule_db_export_t)(struct rte_regexdev *dev,
                     char *rule_db);
typedef int (*regexdev_xstats_names_get_t)(struct rte_regexdev *dev,
                       struct rte_regexdev_xstats_map
                       *xstats_map);
typedef int (*regexdev_xstats_get_t)(struct rte_regexdev *dev,
                     const uint16_t *ids, uint64_t *values,
                     uint16_t nb_values);
typedef int (*regexdev_xstats_by_name_get_t)(struct rte_regexdev *dev,
                         const char *name, uint16_t *id,
                         uint64_t *value);
typedef int (*regexdev_xstats_reset_t)(struct rte_regexdev *dev,
                       const uint16_t *ids,
                       uint16_t nb_ids);
typedef int (*regexdev_selftest_t)(struct rte_regexdev *dev);
typedef int (*regexdev_dump_t)(struct rte_regexdev *dev, FILE *f);
typedef uint16_t (*regexdev_enqueue_t)(struct rte_regexdev *dev, uint16_t qp_id,
                       struct rte_regex_ops **ops,
                       uint16_t nb_ops);
typedef uint16_t (*regexdev_dequeue_t)(struct rte_regexdev *dev, uint16_t qp_id,
                       struct rte_regex_ops **ops,
                       uint16_t nb_ops);
struct rte_regexdev_ops {
    regexdev_info_get_t dev_info_get;
    regexdev_configure_t dev_configure;
    regexdev_qp_setup_t dev_qp_setup;
    regexdev_start_t dev_start;
    regexdev_stop_t dev_stop;
    regexdev_close_t dev_close;
    regexdev_attr_get_t dev_attr_get;
    regexdev_attr_set_t dev_attr_set;
    regexdev_rule_db_update_t dev_rule_db_update;
    regexdev_rule_db_compile_activate_t dev_rule_db_compile_activate;
    regexdev_rule_db_import_t dev_db_import;
    regexdev_rule_db_export_t dev_db_export;
    regexdev_xstats_names_get_t dev_xstats_names_get;
    regexdev_xstats_get_t dev_xstats_get;
    regexdev_xstats_by_name_get_t dev_xstats_by_name_get;
    regexdev_xstats_reset_t dev_xstats_reset;
    regexdev_selftest_t dev_selftest;
    regexdev_dump_t dev_dump;
};

enum rte_regexdev_state {
    RTE_REGEXDEV_UNUSED = 0, 
    RTE_REGEXDEV_REGISTERED,
    RTE_REGEXDEV_READY,
};

struct rte_regexdev_data {
    void *dev_private; 
    char dev_name[RTE_REGEXDEV_NAME_MAX_LEN]; 
    uint16_t dev_id; 
    struct rte_regexdev_config dev_conf; 
    uint8_t dev_started : 1; 
} __rte_cache_aligned;

struct rte_regexdev {
    regexdev_enqueue_t enqueue;
    regexdev_dequeue_t dequeue;
    const struct rte_regexdev_ops *dev_ops;
    struct rte_device *device; 
    enum rte_regexdev_state state; 
    struct rte_regexdev_data *data;  
} __rte_cache_aligned;

extern struct rte_regexdev rte_regex_devices[];

#endif /* _RTE_REGEX_CORE_H_ */