DPDK  19.08.0-rc0
Data Structures | Macros | Typedefs | Functions
rte_bbdev_pmd.h File Reference
#include <stdint.h>
#include <rte_log.h>
#include "rte_bbdev.h"

Go to the source code of this file.

Data Structures

struct  rte_bbdev_ops
 

Macros

#define RTE_BBDEV_DEFAULT_MAX_NB_QUEUES   RTE_MAX_LCORE
 
#define RTE_BBDEV_QUEUE_SIZE_LIMIT   16384
 

Typedefs

typedef int(* rte_bbdev_setup_queues_t) (struct rte_bbdev *dev, uint16_t num_queues, int socket_id)
 

Functions

struct rte_bbdev *__rte_experimental rte_bbdev_get_named_dev (const char *name)
 
void __rte_experimental rte_bbdev_pmd_callback_process (struct rte_bbdev *dev, enum rte_bbdev_event_type event, void *ret_param)
 

Detailed Description

Wireless base band driver-facing APIs.

Warning
EXPERIMENTAL: this API may change without prior notice

This API provides the mechanism for device drivers to register with the bbdev interface. User applications should not use this API.

Definition in file rte_bbdev_pmd.h.

Macro Definition Documentation

◆ RTE_BBDEV_DEFAULT_MAX_NB_QUEUES

#define RTE_BBDEV_DEFAULT_MAX_NB_QUEUES   RTE_MAX_LCORE

Suggested value for SW based devices

Definition at line 30 of file rte_bbdev_pmd.h.

◆ RTE_BBDEV_QUEUE_SIZE_LIMIT

#define RTE_BBDEV_QUEUE_SIZE_LIMIT   16384

Suggested value for SW based devices

Definition at line 33 of file rte_bbdev_pmd.h.

Typedef Documentation

◆ rte_bbdev_setup_queues_t

typedef int(* rte_bbdev_setup_queues_t) (struct rte_bbdev *dev, uint16_t num_queues, int socket_id)

Definitions of all functions exported by a driver through the the generic structure of type rte_bbdev_ops supplied in the rte_bbdev structure associated with a device.

Definition at line 82 of file rte_bbdev_pmd.h.

Function Documentation

◆ rte_bbdev_get_named_dev()

struct rte_bbdev* __rte_experimental rte_bbdev_get_named_dev ( const char *  name)

Get the device structure for a named device.

Parameters
nameName of the device
Returns
  • The device structure pointer, or
  • NULL otherwise

◆ rte_bbdev_pmd_callback_process()

void __rte_experimental rte_bbdev_pmd_callback_process ( struct rte_bbdev *  dev,
enum rte_bbdev_event_type  event,
void *  ret_param 
)

Executes all the user application registered callbacks for the specific device and event type.

Parameters
devPointer to the device structure.
eventEvent type.
ret_paramTo pass data back to user application.