eventdev: define southbound driver interface
Signed-off-by: Jerin Jacob <jerin.jacob@caviumnetworks.com> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
This commit is contained in:
Jerin Jacob
parent
71f2384328
commit
5223a1f3b8
@ -972,6 +972,44 @@ struct rte_event {
|
||||
};
|
||||
};
|
||||
|
||||
struct rte_eventdev_ops;
|
||||
struct rte_eventdev;
|
||||
|
||||
typedef void (*event_schedule_t)(struct rte_eventdev *dev);
|
||||
/**< @internal Schedule one or more events in the event dev. */
|
||||
|
||||
typedef uint16_t (*event_enqueue_t)(void *port, const struct rte_event *ev);
|
||||
/**< @internal Enqueue event on port of a device */
|
||||
|
||||
typedef uint16_t (*event_enqueue_burst_t)(void *port,
|
||||
const struct rte_event ev[], uint16_t nb_events);
|
||||
/**< @internal Enqueue burst of events on port of a device */
|
||||
|
||||
typedef uint16_t (*event_dequeue_t)(void *port, struct rte_event *ev,
|
||||
uint64_t timeout_ticks);
|
||||
/**< @internal Dequeue event from port of a device */
|
||||
|
||||
typedef uint16_t (*event_dequeue_burst_t)(void *port, struct rte_event ev[],
|
||||
uint16_t nb_events, uint64_t timeout_ticks);
|
||||
/**< @internal Dequeue burst of events from port of a device */
|
||||
|
||||
|
||||
/** @internal The data structure associated with each event device. */
|
||||
struct rte_eventdev {
|
||||
event_schedule_t schedule;
|
||||
/**< Pointer to PMD schedule function. */
|
||||
event_enqueue_t enqueue;
|
||||
/**< Pointer to PMD enqueue function. */
|
||||
event_enqueue_burst_t enqueue_burst;
|
||||
/**< Pointer to PMD enqueue burst function. */
|
||||
event_dequeue_t dequeue;
|
||||
/**< Pointer to PMD dequeue function. */
|
||||
event_dequeue_burst_t dequeue_burst;
|
||||
/**< Pointer to PMD dequeue burst function. */
|
||||
|
||||
} __rte_cache_aligned;
|
||||
|
||||
|
||||
/**
|
||||
* Schedule one or more events in the event dev.
|
||||
*
|
||||
|
||||
294
lib/librte_eventdev/rte_eventdev_pmd.h
Normal file
294
lib/librte_eventdev/rte_eventdev_pmd.h
Normal file
@ -0,0 +1,294 @@
|
||||
/*
|
||||
*
|
||||
* Copyright(c) 2016 Cavium networks. All rights reserved.
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
* are met:
|
||||
*
|
||||
* * Redistributions of source code must retain the above copyright
|
||||
* notice, this list of conditions and the following disclaimer.
|
||||
* * Redistributions in binary form must reproduce the above copyright
|
||||
* notice, this list of conditions and the following disclaimer in
|
||||
* the documentation and/or other materials provided with the
|
||||
* distribution.
|
||||
* * Neither the name of Cavium networks nor the names of its
|
||||
* contributors may be used to endorse or promote products derived
|
||||
* from this software without specific prior written permission.
|
||||
*
|
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
*/
|
||||
|
||||
#ifndef _RTE_EVENTDEV_PMD_H_
|
||||
#define _RTE_EVENTDEV_PMD_H_
|
||||
|
||||
/** @file
|
||||
* RTE Event PMD APIs
|
||||
*
|
||||
* @note
|
||||
* These API are from event PMD only and user applications should not call
|
||||
* them directly.
|
||||
*/
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#include "rte_eventdev.h"
|
||||
|
||||
/**
|
||||
* Definitions of all functions exported by a driver through the
|
||||
* the generic structure of type *event_dev_ops* supplied in the
|
||||
* *rte_eventdev* structure associated with a device.
|
||||
*/
|
||||
|
||||
/**
|
||||
* Get device information of a device.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param dev_info
|
||||
* Event device information structure
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success
|
||||
*/
|
||||
typedef void (*eventdev_info_get_t)(struct rte_eventdev *dev,
|
||||
struct rte_event_dev_info *dev_info);
|
||||
|
||||
/**
|
||||
* Configure a device.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success
|
||||
*/
|
||||
typedef int (*eventdev_configure_t)(const struct rte_eventdev *dev);
|
||||
|
||||
/**
|
||||
* Start a configured device.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success
|
||||
*/
|
||||
typedef int (*eventdev_start_t)(struct rte_eventdev *dev);
|
||||
|
||||
/**
|
||||
* Stop a configured device.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
*/
|
||||
typedef void (*eventdev_stop_t)(struct rte_eventdev *dev);
|
||||
|
||||
/**
|
||||
* Close a configured device.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
*
|
||||
* @return
|
||||
* - 0 on success
|
||||
* - (-EAGAIN) if can't close as device is busy
|
||||
*/
|
||||
typedef int (*eventdev_close_t)(struct rte_eventdev *dev);
|
||||
|
||||
/**
|
||||
* Retrieve the default event queue configuration.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param queue_id
|
||||
* Event queue index
|
||||
* @param[out] queue_conf
|
||||
* Event queue configuration structure
|
||||
*
|
||||
*/
|
||||
typedef void (*eventdev_queue_default_conf_get_t)(struct rte_eventdev *dev,
|
||||
uint8_t queue_id, struct rte_event_queue_conf *queue_conf);
|
||||
|
||||
/**
|
||||
* Setup an event queue.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param queue_id
|
||||
* Event queue index
|
||||
* @param queue_conf
|
||||
* Event queue configuration structure
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success.
|
||||
*/
|
||||
typedef int (*eventdev_queue_setup_t)(struct rte_eventdev *dev,
|
||||
uint8_t queue_id,
|
||||
const struct rte_event_queue_conf *queue_conf);
|
||||
|
||||
/**
|
||||
* Release resources allocated by given event queue.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param queue_id
|
||||
* Event queue index
|
||||
*
|
||||
*/
|
||||
typedef void (*eventdev_queue_release_t)(struct rte_eventdev *dev,
|
||||
uint8_t queue_id);
|
||||
|
||||
/**
|
||||
* Retrieve the default event port configuration.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param port_id
|
||||
* Event port index
|
||||
* @param[out] port_conf
|
||||
* Event port configuration structure
|
||||
*
|
||||
*/
|
||||
typedef void (*eventdev_port_default_conf_get_t)(struct rte_eventdev *dev,
|
||||
uint8_t port_id, struct rte_event_port_conf *port_conf);
|
||||
|
||||
/**
|
||||
* Setup an event port.
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param port_id
|
||||
* Event port index
|
||||
* @param port_conf
|
||||
* Event port configuration structure
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success.
|
||||
*/
|
||||
typedef int (*eventdev_port_setup_t)(struct rte_eventdev *dev,
|
||||
uint8_t port_id,
|
||||
const struct rte_event_port_conf *port_conf);
|
||||
|
||||
/**
|
||||
* Release memory resources allocated by given event port.
|
||||
*
|
||||
* @param port
|
||||
* Event port pointer
|
||||
*
|
||||
*/
|
||||
typedef void (*eventdev_port_release_t)(void *port);
|
||||
|
||||
/**
|
||||
* Link multiple source event queues to destination event port.
|
||||
*
|
||||
* @param port
|
||||
* Event port pointer
|
||||
* @param link
|
||||
* Points to an array of *nb_links* event queues to be linked
|
||||
* to the event port.
|
||||
* @param priorities
|
||||
* Points to an array of *nb_links* service priorities associated with each
|
||||
* event queue link to event port.
|
||||
* @param nb_links
|
||||
* The number of links to establish
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success.
|
||||
*
|
||||
*/
|
||||
typedef int (*eventdev_port_link_t)(void *port,
|
||||
const uint8_t queues[], const uint8_t priorities[],
|
||||
uint16_t nb_links);
|
||||
|
||||
/**
|
||||
* Unlink multiple source event queues from destination event port.
|
||||
*
|
||||
* @param port
|
||||
* Event port pointer
|
||||
* @param queues
|
||||
* An array of *nb_unlinks* event queues to be unlinked from the event port.
|
||||
* @param nb_unlinks
|
||||
* The number of unlinks to establish
|
||||
*
|
||||
* @return
|
||||
* Returns 0 on success.
|
||||
*
|
||||
*/
|
||||
typedef int (*eventdev_port_unlink_t)(void *port,
|
||||
uint8_t queues[], uint16_t nb_unlinks);
|
||||
|
||||
/**
|
||||
* Converts nanoseconds to *timeout_ticks* value for rte_event_dequeue()
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param ns
|
||||
* Wait time in nanosecond
|
||||
* @param[out] timeout_ticks
|
||||
* Value for the *timeout_ticks* parameter in rte_event_dequeue() function
|
||||
*
|
||||
*/
|
||||
typedef void (*eventdev_dequeue_timeout_ticks_t)(struct rte_eventdev *dev,
|
||||
uint64_t ns, uint64_t *timeout_ticks);
|
||||
|
||||
/**
|
||||
* Dump internal information
|
||||
*
|
||||
* @param dev
|
||||
* Event device pointer
|
||||
* @param f
|
||||
* A pointer to a file for output
|
||||
*
|
||||
*/
|
||||
typedef void (*eventdev_dump_t)(struct rte_eventdev *dev, FILE *f);
|
||||
|
||||
/** Event device operations function pointer table */
|
||||
struct rte_eventdev_ops {
|
||||
eventdev_info_get_t dev_infos_get; /**< Get device info. */
|
||||
eventdev_configure_t dev_configure; /**< Configure device. */
|
||||
eventdev_start_t dev_start; /**< Start device. */
|
||||
eventdev_stop_t dev_stop; /**< Stop device. */
|
||||
eventdev_close_t dev_close; /**< Close device. */
|
||||
|
||||
eventdev_queue_default_conf_get_t queue_def_conf;
|
||||
/**< Get default queue configuration. */
|
||||
eventdev_queue_setup_t queue_setup;
|
||||
/**< Set up an event queue. */
|
||||
eventdev_queue_release_t queue_release;
|
||||
/**< Release an event queue. */
|
||||
|
||||
eventdev_port_default_conf_get_t port_def_conf;
|
||||
/**< Get default port configuration. */
|
||||
eventdev_port_setup_t port_setup;
|
||||
/**< Set up an event port. */
|
||||
eventdev_port_release_t port_release;
|
||||
/**< Release an event port. */
|
||||
|
||||
eventdev_port_link_t port_link;
|
||||
/**< Link event queues to an event port. */
|
||||
eventdev_port_unlink_t port_unlink;
|
||||
/**< Unlink event queues from an event port. */
|
||||
eventdev_dequeue_timeout_ticks_t timeout_ticks;
|
||||
/**< Converts ns to *timeout_ticks* value for rte_event_dequeue() */
|
||||
eventdev_dump_t dump;
|
||||
/* Dump internal information */
|
||||
};
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* _RTE_EVENTDEV_PMD_H_ */
|
||||
Loading…
Reference in New Issue
Block a user