1/*
2 * Copyright (c) 2015-2016 Cisco and/or its affiliates.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at:
6 *
7 *     http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
14 */
15
16/** \file
17
18    This file defines packet-generator interface APIs.
19*/
20
21option version = "2.0.0";
22
23import "vnet/interface_types.api";
24
25/** \brief PacketGenerator create interface request
26    @param client_index - opaque cookie to identify the sender
27    @param context - sender context, to match reply w/ request
28    @param interface_id - interface index
29    @param gso_enabled - enable gso on this interface
30    @param gso_size - gso size on this interface
31*/
32define pg_create_interface
33{
34  u32 client_index;
35  u32 context;
36  vl_api_interface_index_t interface_id;
37  bool gso_enabled;
38  u32 gso_size;
39};
40
41/** \brief PacketGenerator create interface response
42    @param context - sender context, to match reply w/ request
43    @param retval - return value for request
44*/
45define pg_create_interface_reply
46{
47  u32 context;
48  i32 retval;
49  vl_api_interface_index_t sw_if_index;
50};
51
52/** \brief PacketGenerator capture packets on given interface request
53    @param client_index - opaque cookie to identify the sender
54    @param context - sender context, to match reply w/ request
55    @param interface_id - pg interface index
56    @param is_enabled - 1 if enabling streams, 0 if disabling
57    @param count - number of packets to be captured
58    @param pcap_file_name - pacp file name to store captured packets
59*/
60autoreply define pg_capture
61{
62  u32 client_index;
63  u32 context;
64  vl_api_interface_index_t interface_id;
65  bool is_enabled [default=true];
66  u32 count;
67  string pcap_file_name[];
68};
69
70/** \brief Enable / disable packet generator request
71    @param client_index - opaque cookie to identify the sender
72    @param context - sender context, to match reply w/ request
73    @param is_enabled - 1 if enabling streams, 0 if disabling
74    @param stream_name - stream name to be enable/disabled, if not specified handle all streams
75*/
76autoreply define pg_enable_disable
77{
78  u32 client_index;
79  u32 context;
80  bool is_enabled [default=true];
81  string stream_name[];
82};
83
84/*
85 * Local Variables:
86 * eval: (c-set-style "gnu")
87 * End:
88 */
89