devtools: pass custom options to checkpatch

[dpdk.git] / lib / librte_compressdev / rte_compressdev.h

diff --git a/lib/librte_compressdev/rte_compressdev.h b/lib/librte_compressdev/rte_compressdev.h
index 7b68170..8052efe 100644 (file)
--- a/lib/librte_compressdev/rte_compressdev.h
+++ b/lib/librte_compressdev/rte_compressdev.h
@@ -50,7 +50,8 @@ struct rte_compressdev_capabilities {
 #define RTE_COMP_END_OF_CAPABILITIES_LIST() \
        { RTE_COMP_ALGO_UNSPECIFIED }
 
-const struct rte_compressdev_capabilities * __rte_experimental
+__rte_experimental
+const struct rte_compressdev_capabilities *
 rte_compressdev_capability_get(uint8_t dev_id,
                        enum rte_comp_algorithm algo);
 
@@ -73,6 +74,12 @@ rte_compressdev_capability_get(uint8_t dev_id,
 /**< Utilises CPU SIMD AVX512 instructions */
 #define        RTE_COMPDEV_FF_CPU_NEON                 (1ULL << 5)
 /**< Utilises CPU NEON instructions */
+#define RTE_COMPDEV_FF_OP_DONE_IN_DEQUEUE      (1ULL << 6)
+/**< A PMD should set this if the bulk of the
+ * processing is done during the dequeue. It should leave it
+ * cleared if the processing is done during the enqueue (default).
+ * Applications can use this as a hint for tuning.
+ */
 
 /**
  * Get the name of a compress device feature flag.
@@ -83,7 +90,8 @@ rte_compressdev_capability_get(uint8_t dev_id,
  * @return
  *   The name of this flag, or NULL if it's not a valid feature flag.
  */
-const char * __rte_experimental
+__rte_experimental
+const char *
 rte_compressdev_get_feature_name(uint64_t flag);
 
 /**  comp device information */
@@ -121,7 +129,8 @@ struct rte_compressdev_stats {
  *   - Returns compress device identifier on success.
  *   - Return -1 on failure to find named compress device.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_get_dev_id(const char *name);
 
 /**
@@ -133,7 +142,8 @@ rte_compressdev_get_dev_id(const char *name);
  *   - Returns compress device name.
  *   - Returns NULL if compress device is not present.
  */
-const char * __rte_experimental
+__rte_experimental
+const char *
 rte_compressdev_name_get(uint8_t dev_id);
 
 /**
@@ -143,7 +153,8 @@ rte_compressdev_name_get(uint8_t dev_id);
  * @return
  *   - The total number of usable compress devices.
  */
-uint8_t __rte_experimental
+__rte_experimental
+uint8_t
 rte_compressdev_count(void);
 
 /**
@@ -160,7 +171,8 @@ rte_compressdev_count(void);
  * @return
  *   Returns number of attached compress devices.
  */
-uint8_t __rte_experimental
+__rte_experimental
+uint8_t
 rte_compressdev_devices_get(const char *driver_name, uint8_t *devices,
                uint8_t nb_devices);
 
@@ -174,7 +186,8 @@ rte_compressdev_devices_get(const char *driver_name, uint8_t *devices,
  *   a default of zero if the socket could not be determined.
  *   -1 if returned is the dev_id value is out of range.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_socket_id(uint8_t dev_id);
 
 /** Compress device configuration structure */
@@ -204,7 +217,8 @@ struct rte_compressdev_config {
  *   - 0: Success, device configured.
  *   - <0: Error code returned by the driver configuration function.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_configure(uint8_t dev_id,
                        struct rte_compressdev_config *config);
 
@@ -222,7 +236,8 @@ rte_compressdev_configure(uint8_t dev_id,
  *   - 0: Success, device started.
  *   - <0: Error code of the driver device start function.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_start(uint8_t dev_id);
 
 /**
@@ -232,7 +247,8 @@ rte_compressdev_start(uint8_t dev_id);
  * @param dev_id
  *   Compress device identifier
  */
-void __rte_experimental
+__rte_experimental
+void
 rte_compressdev_stop(uint8_t dev_id);
 
 /**
@@ -249,7 +265,8 @@ rte_compressdev_stop(uint8_t dev_id);
  *  - 0 on successfully closing device
  *  - <0 on failure to close device
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_close(uint8_t dev_id);
 
 /**
@@ -275,7 +292,8 @@ rte_compressdev_close(uint8_t dev_id);
  *   - 0: Success, queue pair correctly set up.
  *   - <0: Queue pair configuration failed
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
                uint32_t max_inflight_ops, int socket_id);
 
@@ -287,7 +305,8 @@ rte_compressdev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
  * @return
  *   - The number of configured queue pairs.
  */
-uint16_t __rte_experimental
+__rte_experimental
+uint16_t
 rte_compressdev_queue_pair_count(uint8_t dev_id);
 
 
@@ -304,7 +323,8 @@ rte_compressdev_queue_pair_count(uint8_t dev_id);
  *   - Zero if successful.
  *   - Non-zero otherwise.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_stats_get(uint8_t dev_id, struct rte_compressdev_stats *stats);
 
 /**
@@ -313,7 +333,8 @@ rte_compressdev_stats_get(uint8_t dev_id, struct rte_compressdev_stats *stats);
  * @param dev_id
  *   The identifier of the device.
  */
-void __rte_experimental
+__rte_experimental
+void
 rte_compressdev_stats_reset(uint8_t dev_id);
 
 /**
@@ -330,7 +351,8 @@ rte_compressdev_stats_reset(uint8_t dev_id);
  * The element after the last valid element has it's op field set to
  * RTE_COMP_ALGO_LIST_END.
  */
-void __rte_experimental
+__rte_experimental
+void
 rte_compressdev_info_get(uint8_t dev_id, struct rte_compressdev_info *dev_info);
 
 /**
@@ -387,7 +409,8 @@ rte_compressdev_info_get(uint8_t dev_id, struct rte_compressdev_info *dev_info);
  *   of pointers to *rte_comp_op* structures effectively supplied to the
  *   *ops* array.
  */
-uint16_t __rte_experimental
+__rte_experimental
+uint16_t
 rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
                struct rte_comp_op **ops, uint16_t nb_ops);
 
@@ -441,7 +464,8 @@ rte_compressdev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
  *   comp devices queue is full or if invalid parameters are specified in
  *   a *rte_comp_op*.
  */
-uint16_t __rte_experimental
+__rte_experimental
+uint16_t
 rte_compressdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
                struct rte_comp_op **ops, uint16_t nb_ops);
 
@@ -469,7 +493,8 @@ rte_compressdev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
  *  - Returns -ENOMEM if the private stream could not be allocated.
  *
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_stream_create(uint8_t dev_id,
                const struct rte_comp_xform *xform,
                void **stream);
@@ -490,7 +515,8 @@ rte_compressdev_stream_create(uint8_t dev_id,
  *  - Returns -ENOTSUP if comp device does not support STATEFUL operations.
  *  - Returns -EBUSY if can't free stream as there are inflight operations
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_stream_free(uint8_t dev_id, void *stream);
 
 /**
@@ -516,7 +542,8 @@ rte_compressdev_stream_free(uint8_t dev_id, void *stream);
  *  - Returns -ENOTSUP if comp device does not support the comp transform.
  *  - Returns -ENOMEM if the private_xform could not be allocated.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_private_xform_create(uint8_t dev_id,
                const struct rte_comp_xform *xform,
                void **private_xform);
@@ -537,7 +564,8 @@ rte_compressdev_private_xform_create(uint8_t dev_id,
  *  - <0 in error cases
  *  - Returns -EINVAL if input parameters are invalid.
  */
-int __rte_experimental
+__rte_experimental
+int
 rte_compressdev_private_xform_free(uint8_t dev_id, void *private_xform);
 
 #ifdef __cplusplus