span: API cleanup
[vpp.git] / src / vnet / span / span.api
index 03cd60e..95d5ad1 100644 (file)
  * limitations under the License.
  */
 
+option version = "2.0.0";
+
+import "vnet/interface_types.api";
+
+enum span_state
+{
+       SPAN_STATE_API_DISABLED = 0,
+       SPAN_STATE_API_RX = 1,
+       SPAN_STATE_API_TX = 2,
+       SPAN_STATE_API_RX_TX = 3,
+};
+
  /** \brief Enable/Disable span to mirror traffic from one interface to another
     @param client_index - opaque cookie to identify the sender
     @param context - sender context which was passed in the request
-    @param sw_if_index_from - interface to be mirorred
+    @param sw_if_index_from - interface to be mirrored
     @param sw_if_index_to - interface where the traffic is mirrored
     @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
     @param is_l2 - 0 = mirror at hw device level, 1 = mirror at L2
 autoreply define sw_interface_span_enable_disable {
     u32 client_index;
     u32 context;
-    u32 sw_if_index_from;
-    u32 sw_if_index_to;
-    u8  state;
-    u8  is_l2;
+    vl_api_interface_index_t sw_if_index_from;
+    vl_api_interface_index_t sw_if_index_to;
+    vl_api_span_state_t state;
+    bool is_l2;
 };
 
 /** \brief SPAN dump request
@@ -39,18 +51,20 @@ autoreply define sw_interface_span_enable_disable {
 define sw_interface_span_dump {
     u32 client_index;
     u32 context;
-    u8 is_l2;
+    bool is_l2;
 };
 
 /** \brief Reply to SPAN dump request
     @param context - sender context which was passed in the request
-    @param sw_if_index_from - mirorred interface
+    @param sw_if_index_from - mirrored interface
     @param sw_if_index_to - interface where the traffic is mirrored
     @param state - 0 = disabled, 1 = rx enabled, 2 = tx enabled, 3 tx & rx enabled
+    @param is_l2 - 0 = mirrored at hw device level, 1 = mirrored at l2
 */
 define sw_interface_span_details {
     u32 context;
-    u32 sw_if_index_from;
-    u32 sw_if_index_to;
-    u8 state;
+    vl_api_interface_index_t sw_if_index_from;
+    vl_api_interface_index_t sw_if_index_to;
+    vl_api_span_state_t state;
+    bool is_l2;
 };