Some parameters of typedef'ed function pointers were not properly listed
in the doxygen comments.
The error is seen with doxygen 1.9 which added this specific check:
https://github.com/doxygen/doxygen/commit/
d34236ba4037
Cc: stable@dpdk.org
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
*
* @param dev
* Compress device
*
* @param dev
* Compress device
+ * @param dev_info
+ * Compress device information to populate
*/
typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
struct rte_compressdev_info *dev_info);
*/
typedef void (*compressdev_info_get_t)(struct rte_compressdev *dev,
struct rte_compressdev_info *dev_info);
* Function used to configure device.
*
* @param dev Crypto device pointer
* Function used to configure device.
*
* @param dev Crypto device pointer
- * config Crypto device configurations
+ * @param config Crypto device configurations
*
* @return Returns 0 on success
*/
*
* @return Returns 0 on success
*/
/**
* Function used to get specific information of a device.
*
/**
* Function used to get specific information of a device.
*
- * @param dev Crypto device pointer
+ * @param dev Crypto device pointer
+ * @param dev_info Pointer to infos structure to populate
*/
typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
struct rte_cryptodev_info *dev_info);
*/
typedef void (*cryptodev_info_get_t)(struct rte_cryptodev *dev,
struct rte_cryptodev_info *dev_info);
*
* @param dev Crypto device pointer
* @param nb_objs number of sessions objects in mempool
*
* @param dev Crypto device pointer
* @param nb_objs number of sessions objects in mempool
- * @param obj_cache l-core object cache size, see *rte_ring_create*
+ * @param obj_cache_size l-core object cache size, see *rte_ring_create*
* @param socket_id Socket Id to allocate mempool on.
*
* @return
* @param socket_id Socket Id to allocate mempool on.
*
* @return
*
* @param dev Crypto device pointer
* @param xform Single or chain of crypto xforms
*
* @param dev Crypto device pointer
* @param xform Single or chain of crypto xforms
- * @param priv_sess Pointer to cryptodev's private session structure
+ * @param session Pointer to cryptodev's private session structure
* @param mp Mempool where the private session is allocated
*
* @return
* @param mp Mempool where the private session is allocated
*
* @return
*
* @param dev Crypto device pointer
* @param xform Single or chain of crypto xforms
*
* @param dev Crypto device pointer
* @param xform Single or chain of crypto xforms
- * @param priv_sess Pointer to cryptodev's private session structure
+ * @param session Pointer to cryptodev's private session structure
* @param mp Mempool where the private session is allocated
*
* @return
* @param mp Mempool where the private session is allocated
*
* @return
*
* @param dev Crypto device pointer.
* @param qp_id Crypto device queue pair index.
*
* @param dev Crypto device pointer.
* @param qp_id Crypto device queue pair index.
- * @param service_type Type of the service requested.
* @param ctx The raw data-path context data.
* @param sess_type session type.
* @param session_ctx Session context data. If NULL the driver
* @param ctx The raw data-path context data.
* @param sess_type session type.
* @param session_ctx Session context data. If NULL the driver
* @param data Data pointer passed to rte_keepalive_register_relay_callback()
* @param id_core ID of the core for which state is being reported
* @param core_state The current state of the core
* @param data Data pointer passed to rte_keepalive_register_relay_callback()
* @param id_core ID of the core for which state is being reported
* @param core_state The current state of the core
- * @param Timestamp of when core was last seen alive
+ * @param last_seen Timestamp of when core was last seen alive
*/
typedef void (*rte_keepalive_relay_callback_t)(
void *data,
*/
typedef void (*rte_keepalive_relay_callback_t)(
void *data,
* Event device pointer
* @param port
* Event port pointer
* Event device pointer
* @param port
* Event port pointer
* 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* event queues to be linked
* to the event port.
* @param priorities
*
* @param dev
* Event device pointer
*
* @param dev
* Event device pointer
+ * @param mode
+ * Level (device, port or queue)
+ * @param queue_port_id
+ * Queue or port number depending on mode
* @param ids
* The stat ids to retrieve
* @param values
* @param ids
* The stat ids to retrieve
* @param values
*
* @param dev
* Event device pointer
*
* @param dev
* Event device pointer
+ * @param mode
+ * Level (device, port or queue)
+ * @param queue_port_id
+ * Queue or port number depending on mode
* @param xstats_names
* Array of name values to be filled in
* @param xstats_names
* Array of name values to be filled in
+ * @param ids
+ * The stat ids to retrieve
* @param size
* Number of values in the xstats_names array
* @return
* @param size
* Number of values in the xstats_names array
* @return
*/
typedef int (*rte_port_out_op_tx_bulk)(
void *port,
*/
typedef int (*rte_port_out_op_tx_bulk)(
void *port,
+ struct rte_mbuf **pkts,
* Input port handle.
*/
typedef void
* Input port handle.
*/
typedef void
* Output port handle.
*/
typedef void
* Output port handle.
*/
typedef void
* Raw device pointer
* @param config
* Void object containing device specific configuration
* Raw device pointer
* @param config
* Void object containing device specific configuration
+ * @param config_size
+ * Size of the memory allocated for the configuration
*
* @return
* Returns 0 on success
*
* @return
* Returns 0 on success
* Raw device queue index
* @param[out] queue_conf
* Raw device queue configuration structure
* Raw device queue index
* @param[out] queue_conf
* Raw device queue configuration structure
+ * @param queue_conf_size
+ * Size of the memory allocated for the configuration
*
* @return
* Returns 0 on success, negative errno on failure
*
* @return
* Returns 0 on success, negative errno on failure
* Rawqueue index
* @param queue_conf
* Rawqueue configuration structure
* Rawqueue index
* @param queue_conf
* Rawqueue configuration structure
+ * @param queue_conf_size
+ * Size of the memory allocated for the configuration
*
* @return
* Returns 0 on success.
*
* @return
* Returns 0 on success.
* This function helps in getting queue count supported, independently. It
* can help in cases where iterator needs to be implemented.
*
* This function helps in getting queue count supported, independently. It
* can help in cases where iterator needs to be implemented.
*
* Raw device pointer
* @return
* Number of queues; 0 is assumed to be a valid response.
* Raw device pointer
* @return
* Number of queues; 0 is assumed to be a valid response.
*
* @param dev
* Raw device pointer
*
* @param dev
* Raw device pointer
* array of buffers
* @param count
* number of buffers passed
* array of buffers
* @param count
* number of buffers passed
*
* @param dev
* Raw device pointer
*
* @param dev
* Raw device pointer
* array of buffers
* @param count
* Max buffers expected to be dequeued
* array of buffers
* @param count
* Max buffers expected to be dequeued
*
* @param dev
* Raw device pointer
*
* @param dev
* Raw device pointer
* void block containing device specific status information
* @return
* 0 for success,
* void block containing device specific status information
* @return
* 0 for success,
*
* @param dev
* Raw device pointer
*
* @param dev
* Raw device pointer
- * @param firmware_file
- * file pointer to firmware area
+ * @param firmware_buf
+ * Pointer to firmware image
* @return
* >0, ~0: for successful load
* <0: for failure
* @return
* >0, ~0: for successful load
* <0: for failure
/**
* Free driver private session data.
*
/**
* Free driver private session data.
*
- * @param dev Crypto/eth device pointer
+ * @param device Crypto/eth device pointer
* @param sess Security session structure
*/
typedef int (*security_session_destroy_t)(void *device,
* @param sess Security session structure
*/
typedef int (*security_session_destroy_t)(void *device,
/**
* Update the mbuf with provided metadata.
*
/**
* Update the mbuf with provided metadata.
*
+ * @param device Crypto/eth device pointer
* @param sess Security session structure
* @param mb Packet buffer
* @param sess Security session structure
* @param mb Packet buffer
+ * @param params Metadata
*
* @return
* - Returns 0 if metadata updated successfully.
* - Returns -ve value for errors.
*/
typedef int (*security_set_pkt_metadata_t)(void *device,
*
* @return
* - Returns 0 if metadata updated successfully.
* - Returns -ve value for errors.
*/
typedef int (*security_set_pkt_metadata_t)(void *device,
- struct rte_security_session *sess, struct rte_mbuf *m,
+ struct rte_security_session *sess, struct rte_mbuf *mb,
* progress and it is passed as a parameter to the lookup operation. This allows
* for multiple concurrent lookup operations into the same table.
*
* progress and it is passed as a parameter to the lookup operation. This allows
* for multiple concurrent lookup operations into the same table.
*
- * @param[in] params
- * Table creation parameters.
- * @param[in] entries
- * Entries to be added to the table at creation time.
- * @param[in] args
- * Any additional table create arguments. It may be NULL.
* @return
* Table memory footprint in bytes, on success, or zero, on error.
*/
* @return
* Table memory footprint in bytes, on success, or zero, on error.
*/
*
* @param table
* Handle to lookup table instance
*
* @param table
* Handle to lookup table instance
* Array containing lookup keys
* @param entries
* Array containing data to be associated with each key. Every item in the
* Array containing lookup keys
* @param entries
* Array containing data to be associated with each key. Every item in the
*
* @param table
* Handle to lookup table instance
*
* @param table
* Handle to lookup table instance
* Array containing lookup keys
* @param n_keys
* Number of keys to delete
* Array containing lookup keys
* @param n_keys
* Number of keys to delete