1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2017 Intel Corporation
11 * Wireless base band device abstraction APIs.
14 * @b EXPERIMENTAL: this API may change without prior notice
16 * This API allows an application to discover, configure and use a device to
17 * process operations. An asynchronous API (enqueue, followed by later dequeue)
18 * is used for processing operations.
20 * The functions in this API are not thread-safe when called on the same
21 * target object (a device, or a queue on a device), with the exception that
22 * one thread can enqueue operations to a queue while another thread dequeues
23 * from the same queue.
34 #include <rte_compat.h>
35 #include <rte_atomic.h>
37 #include <rte_cpuflags.h>
38 #include <rte_memory.h>
40 #include "rte_bbdev_op.h"
42 #ifndef RTE_BBDEV_MAX_DEVS
43 #define RTE_BBDEV_MAX_DEVS 128 /**< Max number of devices */
46 /** Flags indiciate current state of BBDEV device */
47 enum rte_bbdev_state {
53 * Get the total number of devices that have been successfully initialised.
56 * The total number of usable devices.
58 uint16_t __rte_experimental
59 rte_bbdev_count(void);
62 * Check if a device is valid.
65 * The identifier of the device.
68 * true if device ID is valid and device is attached, false otherwise.
70 bool __rte_experimental
71 rte_bbdev_is_valid(uint16_t dev_id);
74 * Get the next enabled device.
80 * - The next device, or
81 * - RTE_BBDEV_MAX_DEVS if none found
83 uint16_t __rte_experimental
84 rte_bbdev_find_next(uint16_t dev_id);
86 /** Iterate through all enabled devices */
87 #define RTE_BBDEV_FOREACH(i) for (i = rte_bbdev_find_next(-1); \
88 i < RTE_BBDEV_MAX_DEVS; \
89 i = rte_bbdev_find_next(i))
92 * Setup up device queues.
93 * This function must be called on a device before setting up the queues and
94 * starting the device. It can also be called when a device is in the stopped
95 * state. If any device queues have been configured their configuration will be
96 * cleared by a call to this function.
99 * The identifier of the device.
101 * Number of queues to configure on device.
103 * ID of a socket which will be used to allocate memory.
107 * - -ENODEV if dev_id is invalid or the device is corrupted
108 * - -EINVAL if num_queues is invalid, 0 or greater than maximum
109 * - -EBUSY if the identified device has already started
110 * - -ENOMEM if unable to allocate memory
112 int __rte_experimental
113 rte_bbdev_setup_queues(uint16_t dev_id, uint16_t num_queues, int socket_id);
117 * This function may be called before starting the device to enable the
118 * interrupts if they are available.
121 * The identifier of the device.
125 * - -ENODEV if dev_id is invalid or the device is corrupted
126 * - -EBUSY if the identified device has already started
127 * - -ENOTSUP if the interrupts are not supported by the device
129 int __rte_experimental
130 rte_bbdev_intr_enable(uint16_t dev_id);
132 /** Device queue configuration structure */
133 struct rte_bbdev_queue_conf {
134 int socket; /**< NUMA socket used for memory allocation */
135 uint32_t queue_size; /**< Size of queue */
136 uint8_t priority; /**< Queue priority */
137 bool deferred_start; /**< Do not start queue when device is started. */
138 enum rte_bbdev_op_type op_type; /**< Operation type */
142 * Configure a queue on a device.
143 * This function can be called after device configuration, and before starting.
144 * It can also be called when the device or the queue is in the stopped state.
147 * The identifier of the device.
149 * The index of the queue.
151 * The queue configuration. If NULL, a default configuration will be used.
155 * - EINVAL if the identified queue size or priority are invalid
156 * - EBUSY if the identified queue or its device have already started
158 int __rte_experimental
159 rte_bbdev_queue_configure(uint16_t dev_id, uint16_t queue_id,
160 const struct rte_bbdev_queue_conf *conf);
164 * This is the last step needed before enqueueing operations is possible.
167 * The identifier of the device.
171 * - negative value on failure - as returned from PMD driver
173 int __rte_experimental
174 rte_bbdev_start(uint16_t dev_id);
178 * The device can be reconfigured, and restarted after being stopped.
181 * The identifier of the device.
186 int __rte_experimental
187 rte_bbdev_stop(uint16_t dev_id);
191 * The device cannot be restarted without reconfiguration!
194 * The identifier of the device.
199 int __rte_experimental
200 rte_bbdev_close(uint16_t dev_id);
203 * Start a specified queue on a device.
204 * This is only needed if the queue has been stopped, or if the deferred_start
205 * flag has been set when configuring the queue.
208 * The identifier of the device.
210 * The index of the queue.
214 * - negative value on failure - as returned from PMD driver
216 int __rte_experimental
217 rte_bbdev_queue_start(uint16_t dev_id, uint16_t queue_id);
220 * Stop a specified queue on a device, to allow re configuration.
223 * The identifier of the device.
225 * The index of the queue.
229 * - negative value on failure - as returned from PMD driver
231 int __rte_experimental
232 rte_bbdev_queue_stop(uint16_t dev_id, uint16_t queue_id);
234 /** Device statistics. */
235 struct rte_bbdev_stats {
236 uint64_t enqueued_count; /**< Count of all operations enqueued */
237 uint64_t dequeued_count; /**< Count of all operations dequeued */
238 /** Total error count on operations enqueued */
239 uint64_t enqueue_err_count;
240 /** Total error count on operations dequeued */
241 uint64_t dequeue_err_count;
245 * Retrieve the general I/O statistics of a device.
248 * The identifier of the device.
250 * Pointer to structure to where statistics will be copied. On error, this
251 * location may or may not have been modified.
255 * - EINVAL if invalid parameter pointer is provided
257 int __rte_experimental
258 rte_bbdev_stats_get(uint16_t dev_id, struct rte_bbdev_stats *stats);
261 * Reset the statistics of a device.
264 * The identifier of the device.
268 int __rte_experimental
269 rte_bbdev_stats_reset(uint16_t dev_id);
271 /** Device information supplied by the device's driver */
272 struct rte_bbdev_driver_info {
274 const char *driver_name;
276 /** Maximum number of queues supported by the device */
277 unsigned int max_num_queues;
278 /** Queue size limit (queue size must also be power of 2) */
279 uint32_t queue_size_lim;
280 /** Set if device off-loads operation to hardware */
281 bool hardware_accelerated;
282 /** Max value supported by queue priority */
283 uint8_t max_queue_priority;
284 /** Set if device supports per-queue interrupts */
285 bool queue_intr_supported;
286 /** Minimum alignment of buffers, in bytes */
287 uint16_t min_alignment;
288 /** Default queue configuration used if none is supplied */
289 struct rte_bbdev_queue_conf default_queue_conf;
290 /** Device operation capabilities */
291 const struct rte_bbdev_op_cap *capabilities;
292 /** Device cpu_flag requirements */
293 const enum rte_cpu_flag_t *cpu_flag_reqs;
296 /** Macro used at end of bbdev PMD list */
297 #define RTE_BBDEV_END_OF_CAPABILITIES_LIST() \
298 { RTE_BBDEV_OP_NONE }
301 * Device information structure used by an application to discover a devices
302 * capabilities and current configuration
304 struct rte_bbdev_info {
305 int socket_id; /**< NUMA socket that device is on */
306 const char *dev_name; /**< Unique device name */
307 const struct rte_bus *bus; /**< Bus information */
308 uint16_t num_queues; /**< Number of queues currently configured */
309 bool started; /**< Set if device is currently started */
310 struct rte_bbdev_driver_info drv; /**< Info from device driver */
314 * Retrieve information about a device.
317 * The identifier of the device.
319 * Pointer to structure to where information will be copied. On error, this
320 * location may or may not have been modified.
324 * - EINVAL if invalid parameter pointer is provided
326 int __rte_experimental
327 rte_bbdev_info_get(uint16_t dev_id, struct rte_bbdev_info *dev_info);
329 /** Queue information */
330 struct rte_bbdev_queue_info {
331 /** Current device configuration */
332 struct rte_bbdev_queue_conf conf;
333 /** Set if queue is currently started */
338 * Retrieve information about a specific queue on a device.
341 * The identifier of the device.
343 * The index of the queue.
345 * Pointer to structure to where information will be copied. On error, this
346 * location may or may not have been modified.
350 * - EINVAL if invalid parameter pointer is provided
352 int __rte_experimental
353 rte_bbdev_queue_info_get(uint16_t dev_id, uint16_t queue_id,
354 struct rte_bbdev_queue_info *queue_info);
356 /** @internal The data structure associated with each queue of a device. */
357 struct rte_bbdev_queue_data {
358 void *queue_private; /**< Driver-specific per-queue data */
359 struct rte_bbdev_queue_conf conf; /**< Current configuration */
360 struct rte_bbdev_stats queue_stats; /**< Queue statistics */
361 bool started; /**< Queue state */
364 /** @internal Enqueue encode operations for processing on queue of a device. */
365 typedef uint16_t (*rte_bbdev_enqueue_enc_ops_t)(
366 struct rte_bbdev_queue_data *q_data,
367 struct rte_bbdev_enc_op **ops,
370 /** @internal Enqueue decode operations for processing on queue of a device. */
371 typedef uint16_t (*rte_bbdev_enqueue_dec_ops_t)(
372 struct rte_bbdev_queue_data *q_data,
373 struct rte_bbdev_dec_op **ops,
376 /** @internal Dequeue encode operations from a queue of a device. */
377 typedef uint16_t (*rte_bbdev_dequeue_enc_ops_t)(
378 struct rte_bbdev_queue_data *q_data,
379 struct rte_bbdev_enc_op **ops, uint16_t num);
381 /** @internal Dequeue decode operations from a queue of a device. */
382 typedef uint16_t (*rte_bbdev_dequeue_dec_ops_t)(
383 struct rte_bbdev_queue_data *q_data,
384 struct rte_bbdev_dec_op **ops, uint16_t num);
386 #define RTE_BBDEV_NAME_MAX_LEN 64 /**< Max length of device name */
389 * @internal The data associated with a device, with no function pointers.
390 * This structure is safe to place in shared memory to be common among
391 * different processes in a multi-process configuration. Drivers can access
392 * these fields, but should never write to them!
394 struct rte_bbdev_data {
395 char name[RTE_BBDEV_NAME_MAX_LEN]; /**< Unique identifier name */
396 void *dev_private; /**< Driver-specific private data */
397 uint16_t num_queues; /**< Number of currently configured queues */
398 struct rte_bbdev_queue_data *queues; /**< Queue structures */
399 uint16_t dev_id; /**< Device ID */
400 int socket_id; /**< NUMA socket that device is on */
401 bool started; /**< Device run-time state */
402 /** Counter of processes using the device */
403 rte_atomic16_t process_cnt;
406 /* Forward declarations */
407 struct rte_bbdev_ops;
408 struct rte_bbdev_callback;
409 struct rte_intr_handle;
411 /** Structure to keep track of registered callbacks */
412 TAILQ_HEAD(rte_bbdev_cb_list, rte_bbdev_callback);
415 * @internal The data structure associated with a device. Drivers can access
416 * these fields, but should only write to the *_ops fields.
418 struct __rte_cache_aligned rte_bbdev {
419 /**< Enqueue encode function */
420 rte_bbdev_enqueue_enc_ops_t enqueue_enc_ops;
421 /**< Enqueue decode function */
422 rte_bbdev_enqueue_dec_ops_t enqueue_dec_ops;
423 /**< Dequeue encode function */
424 rte_bbdev_dequeue_enc_ops_t dequeue_enc_ops;
425 /**< Dequeue decode function */
426 rte_bbdev_dequeue_dec_ops_t dequeue_dec_ops;
427 const struct rte_bbdev_ops *dev_ops; /**< Functions exported by PMD */
428 struct rte_bbdev_data *data; /**< Pointer to device data */
429 enum rte_bbdev_state state; /**< If device is currently used or not */
430 struct rte_device *device; /**< Backing device */
431 /** User application callback for interrupts if present */
432 struct rte_bbdev_cb_list list_cbs;
433 struct rte_intr_handle *intr_handle; /**< Device interrupt handle */
436 /** @internal array of all devices */
437 extern struct rte_bbdev rte_bbdev_devices[];
440 * Enqueue a burst of processed encode operations to a queue of the device.
441 * This functions only enqueues as many operations as currently possible and
442 * does not block until @p num_ops entries in the queue are available.
443 * This function does not provide any error notification to avoid the
444 * corresponding overhead.
447 * The identifier of the device.
449 * The index of the queue.
451 * Pointer array containing operations to be enqueued Must have at least
454 * The maximum number of operations to enqueue.
457 * The number of operations actually enqueued (this is the number of processed
458 * entries in the @p ops array).
460 static inline uint16_t
461 rte_bbdev_enqueue_enc_ops(uint16_t dev_id, uint16_t queue_id,
462 struct rte_bbdev_enc_op **ops, uint16_t num_ops)
464 struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
465 struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
466 return dev->enqueue_enc_ops(q_data, ops, num_ops);
470 * Enqueue a burst of processed decode operations to a queue of the device.
471 * This functions only enqueues as many operations as currently possible and
472 * does not block until @p num_ops entries in the queue are available.
473 * This function does not provide any error notification to avoid the
474 * corresponding overhead.
477 * The identifier of the device.
479 * The index of the queue.
481 * Pointer array containing operations to be enqueued Must have at least
484 * The maximum number of operations to enqueue.
487 * The number of operations actually enqueued (this is the number of processed
488 * entries in the @p ops array).
490 static inline uint16_t
491 rte_bbdev_enqueue_dec_ops(uint16_t dev_id, uint16_t queue_id,
492 struct rte_bbdev_dec_op **ops, uint16_t num_ops)
494 struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
495 struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
496 return dev->enqueue_dec_ops(q_data, ops, num_ops);
500 * Dequeue a burst of processed encode operations from a queue of the device.
501 * This functions returns only the current contents of the queue, and does not
502 * block until @ num_ops is available.
503 * This function does not provide any error notification to avoid the
504 * corresponding overhead.
507 * The identifier of the device.
509 * The index of the queue.
511 * Pointer array where operations will be dequeued to. Must have at least
514 * The maximum number of operations to dequeue.
517 * The number of operations actually dequeued (this is the number of entries
518 * copied into the @p ops array).
520 static inline uint16_t
521 rte_bbdev_dequeue_enc_ops(uint16_t dev_id, uint16_t queue_id,
522 struct rte_bbdev_enc_op **ops, uint16_t num_ops)
524 struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
525 struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
526 return dev->dequeue_enc_ops(q_data, ops, num_ops);
530 * Dequeue a burst of processed decode operations from a queue of the device.
531 * This functions returns only the current contents of the queue, and does not
532 * block until @ num_ops is available.
533 * This function does not provide any error notification to avoid the
534 * corresponding overhead.
537 * The identifier of the device.
539 * The index of the queue.
541 * Pointer array where operations will be dequeued to. Must have at least
544 * The maximum number of operations to dequeue.
547 * The number of operations actually dequeued (this is the number of entries
548 * copied into the @p ops array).
551 static inline uint16_t
552 rte_bbdev_dequeue_dec_ops(uint16_t dev_id, uint16_t queue_id,
553 struct rte_bbdev_dec_op **ops, uint16_t num_ops)
555 struct rte_bbdev *dev = &rte_bbdev_devices[dev_id];
556 struct rte_bbdev_queue_data *q_data = &dev->data->queues[queue_id];
557 return dev->dequeue_dec_ops(q_data, ops, num_ops);
560 /** Definitions of device event types */
561 enum rte_bbdev_event_type {
562 RTE_BBDEV_EVENT_UNKNOWN, /**< unknown event type */
563 RTE_BBDEV_EVENT_ERROR, /**< error interrupt event */
564 RTE_BBDEV_EVENT_DEQUEUE, /**< dequeue event */
565 RTE_BBDEV_EVENT_MAX /**< max value of this enum */
569 * Typedef for application callback function registered by application
570 * software for notification of device events
575 * Device event to register for notification of.
577 * User specified parameter to be passed to user's callback function.
579 * To pass data back to user application.
581 typedef void (*rte_bbdev_cb_fn)(uint16_t dev_id,
582 enum rte_bbdev_event_type event, void *cb_arg,
586 * Register a callback function for specific device id. Multiple callbacks can
587 * be added and will be called in the order they are added when an event is
588 * triggered. Callbacks are called in a separate thread created by the DPDK EAL.
593 * The event that the callback will be registered for.
595 * User supplied callback function to be called.
597 * Pointer to parameter that will be passed to the callback.
600 * Zero on success, negative value on failure.
602 int __rte_experimental
603 rte_bbdev_callback_register(uint16_t dev_id, enum rte_bbdev_event_type event,
604 rte_bbdev_cb_fn cb_fn, void *cb_arg);
607 * Unregister a callback function for specific device id.
610 * The device identifier.
612 * The event that the callback will be unregistered for.
614 * User supplied callback function to be unregistered.
616 * Pointer to the parameter supplied when registering the callback.
617 * (void *)-1 means to remove all registered callbacks with the specified
622 * - EINVAL if invalid parameter pointer is provided
623 * - EAGAIN if the provided callback pointer does not exist
625 int __rte_experimental
626 rte_bbdev_callback_unregister(uint16_t dev_id, enum rte_bbdev_event_type event,
627 rte_bbdev_cb_fn cb_fn, void *cb_arg);
630 * Enable a one-shot interrupt on the next operation enqueued to a particular
631 * queue. The interrupt will be triggered when the operation is ready to be
632 * dequeued. To handle the interrupt, an epoll file descriptor must be
633 * registered using rte_bbdev_queue_intr_ctl(), and then an application
634 * thread/lcore can wait for the interrupt using rte_epoll_wait().
637 * The device identifier.
639 * The index of the queue.
643 * - negative value on failure - as returned from PMD driver
645 int __rte_experimental
646 rte_bbdev_queue_intr_enable(uint16_t dev_id, uint16_t queue_id);
649 * Disable a one-shot interrupt on the next operation enqueued to a particular
650 * queue (if it has been enabled).
653 * The device identifier.
655 * The index of the queue.
659 * - negative value on failure - as returned from PMD driver
661 int __rte_experimental
662 rte_bbdev_queue_intr_disable(uint16_t dev_id, uint16_t queue_id);
665 * Control interface for per-queue interrupts.
668 * The device identifier.
670 * The index of the queue.
672 * Epoll file descriptor that will be associated with the interrupt source.
673 * If the special value RTE_EPOLL_PER_THREAD is provided, a per thread epoll
674 * file descriptor created by the EAL is used (RTE_EPOLL_PER_THREAD can also
675 * be used when calling rte_epoll_wait()).
677 * The operation be performed for the vector.RTE_INTR_EVENT_ADD or
678 * RTE_INTR_EVENT_DEL.
680 * User context, that will be returned in the epdata.data field of the
681 * rte_epoll_event structure filled in by rte_epoll_wait().
685 * - ENOTSUP if interrupts are not supported by the identified device
686 * - negative value on failure - as returned from PMD driver
688 int __rte_experimental
689 rte_bbdev_queue_intr_ctl(uint16_t dev_id, uint16_t queue_id, int epfd, int op,
696 #endif /* _RTE_BBDEV_H_ */