port: fix minor typo
[dpdk.git] / lib / librte_port / rte_port_ring.h
index 009dcf8..de377d2 100644 (file)
@@ -42,8 +42,14 @@ extern "C" {
  * @file
  * RTE Port Ring
  *
- * ring_reader: input port built on top of pre-initialized single consumer ring
- * ring_writer: output port built on top of pre-initialized single producer ring
+ * ring_reader:
+ *      input port built on top of pre-initialized single consumer ring
+ * ring_writer:
+ *      output port built on top of pre-initialized single producer ring
+ * ring_multi_reader:
+ *      input port built on top of pre-initialized multi consumers ring
+ * ring_multi_writer:
+ *      output port built on top of pre-initialized multi producers ring
  *
  ***/
 
@@ -55,7 +61,7 @@ extern "C" {
 
 /** ring_reader port parameters */
 struct rte_port_ring_reader_params {
-       /** Underlying single consumer ring that has to be pre-initialized */
+       /** Underlying consumer ring that has to be pre-initialized */
        struct rte_ring *ring;
 };
 
@@ -64,7 +70,7 @@ extern struct rte_port_in_ops rte_port_ring_reader_ops;
 
 /** ring_writer port parameters */
 struct rte_port_ring_writer_params {
-       /** Underlying single producer ring that has to be pre-initialized */
+       /** Underlying producer ring that has to be pre-initialized */
        struct rte_ring *ring;
 
        /** Recommended burst size to ring. The actual burst size can be
@@ -75,6 +81,41 @@ struct rte_port_ring_writer_params {
 /** ring_writer port operations */
 extern struct rte_port_out_ops rte_port_ring_writer_ops;
 
+/** ring_writer_nodrop port parameters */
+struct rte_port_ring_writer_nodrop_params {
+       /** Underlying producer ring that has to be pre-initialized */
+       struct rte_ring *ring;
+
+       /** Recommended burst size to ring. The actual burst size can be
+               bigger or smaller than this value. */
+       uint32_t tx_burst_sz;
+
+       /** Maximum number of retries, 0 for no limit */
+       uint32_t n_retries;
+};
+
+/** ring_writer_nodrop port operations */
+extern struct rte_port_out_ops rte_port_ring_writer_nodrop_ops;
+
+/** ring_multi_reader port parameters */
+#define rte_port_ring_multi_reader_params rte_port_ring_reader_params
+
+/** ring_multi_reader port operations */
+extern struct rte_port_in_ops rte_port_ring_multi_reader_ops;
+
+/** ring_multi_writer port parameters */
+#define rte_port_ring_multi_writer_params rte_port_ring_writer_params
+
+/** ring_multi_writer port operations */
+extern struct rte_port_out_ops rte_port_ring_multi_writer_ops;
+
+/** ring_multi_writer_nodrop port parameters */
+#define rte_port_ring_multi_writer_nodrop_params \
+       rte_port_ring_writer_nodrop_params
+
+/** ring_multi_writer_nodrop port operations */
+extern struct rte_port_out_ops rte_port_ring_multi_writer_nodrop_ops;
+
 #ifdef __cplusplus
 }
 #endif