*
* This API allow applications to configure and use generic devices having
* no specific type already available in DPDK.
- *
- * @warning
- * @b EXPERIMENTAL: this API may change without prior notice
*/
#ifdef __cplusplus
#include <rte_memory.h>
#include <rte_errno.h>
-/* Rawdevice object - essentially a void to be typecasted by implementation */
+/* Rawdevice object - essentially a void to be typecast by implementation */
typedef void *rte_rawdev_obj_t;
/**
*
* @param[out] dev_info
* A pointer to a structure of type *rte_rawdev_info* to be filled with the
- * contextual information of the device.
+ * contextual information of the device. The dev_info->dev_private field
+ * should point to an appropriate buffer space for holding the device-
+ * specific info for that hardware.
+ * If the dev_private field is set to NULL, then the device-specific info
+ * function will not be called and only basic information about the device
+ * will be returned. This can be used to safely query the type of a rawdev
+ * instance without needing to know the size of the private data to return.
*
* @return
* - 0: Success, driver updates the contextual information of the raw device
*/
int
rte_rawdev_queue_release(uint16_t dev_id, uint16_t queue_id);
+
/**
* Get the number of raw queues on a specific raw device
*
* @param dev_id
* Raw device identifiers
* @return
- * 0 for sucessful reset,
+ * 0 for successful reset,
* !0 for failure in resetting
*/
int
* @param dev_id
* The identifier of the device to configure.
* @param buffers
- * Collection of buffers for enqueueing
+ * Collection of buffers for enqueuing
* @param count
* Count of buffers to enqueue
* @param context