FD.io VPP
v19.01.3-6-g70449b9b9
Vector Packet Processing
vmxnet3.api
Go to the documentation of this file.
1
/*
2
*------------------------------------------------------------------
3
* Copyright (c) 2018 Cisco and/or its affiliates.
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
* you may not use this file except in compliance with the License.
6
* You may obtain a copy of the License at:
7
*
8
* http://www.apache.org/licenses/LICENSE-2.0
9
*
10
* Unless required by applicable law or agreed to in writing, software
11
* distributed under the License is distributed on an "AS IS" BASIS,
12
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
* See the License for the specific language governing permissions and
14
* limitations under the License.
15
*------------------------------------------------------------------
16
*/
17
18
option
version
=
"1.0.0"
;
19
20
/** \brief
21
@param client_index - opaque cookie to identify the sender
22
@param context - sender context, to match reply w/ request
23
@param pci_addr - pci address as unsigned 32bit integer:
24
0-15 domain, 16-23 bus, 24-28 slot, 29-31 function
25
ddddddddddddddddbbbbbbbbsssssfff
26
@param enable_elog - turn on elog (optional - default is off)
27
@param rxq_size - receive queue size (optional - default is 1024)
28
@param txq_size - transmit queue size (optional - default is 1024)
29
*/
30
31
define vmxnet3_create
32
{
33
u32
client_index
;
34
u32
context
;
35
36
u32
pci_addr
;
37
i32
enable_elog
;
38
u16
rxq_size
;
39
u16
txq_size
;
40
};
41
42
/** \brief
43
@param context - sender context, to match reply w/ request
44
@param retval - return value for request
45
@param sw_if_index - software index for the new vmxnet3 interface
46
*/
47
48
define vmxnet3_create_reply
49
{
50
u32
context
;
51
i32
retval
;
52
u32
sw_if_index
;
53
};
54
55
/** \brief
56
@param client_index - opaque cookie to identify the sender
57
@param context - sender context, to match reply w/ request
58
@param sw_if_index - interface index
59
*/
60
61
autoreply define vmxnet3_delete
62
{
63
u32
client_index
;
64
u32
context
;
65
66
u32
sw_if_index
;
67
};
68
69
/** \brief Memory interface details structure
70
@param context - sender context, to match reply w/ request (memif_dump)
71
@param sw_if_index - index of the interface
72
@param if_name - name of the interface
73
@param hw_addr - interface MAC address
74
@param id - id associated with the interface
75
@param role - role of the interface in the connection (master/slave)
76
@param mode - interface mode
77
@param socket_id - id of the socket filename used by this interface
78
to establish new connections
79
@param ring_size - the number of entries of RX/TX rings
80
@param buffer_size - size of the buffer allocated for each ring entry
81
@param admin_up_down - interface administrative status
82
@param link_up_down - interface link status
83
84
*/
85
define vmxnet3_details
86
{
87
u32
context
;
88
89
u32
sw_if_index
;
90
u8
if_name[64];
91
u8
hw_addr[6];
92
u32
pci_addr
;
93
u8
version
;
94
95
u16
rx_qid
;
96
u16
rx_qsize
;
97
u16
rx_fill[2];
98
u16
rx_next
;
99
u16
rx_produce[2];
100
u16
rx_consume[2];
101
102
u16
tx_qid
;
103
u16
tx_qsize
;
104
u16
tx_next
;
105
u16
tx_produce
;
106
u16
tx_consume
;
107
108
u8
admin_up_down
;
109
};
110
111
/** \brief Dump all vmxnet3 interfaces
112
@param client_index - opaque cookie to identify the sender
113
@param context - sender context, to match reply w/ request
114
*/
115
define vmxnet3_dump
116
{
117
u32
client_index
;
118
u32
context
;
119
};
120
121
/*
122
* Local Variables:
123
* eval: (c-set-style "gnu")
124
* End:
125
*/
vl_api_vmxnet3_details_t::tx_consume
u16 tx_consume
Definition:
vmxnet3.api:106
vl_api_vmxnet3_details_t::admin_up_down
u8 admin_up_down
Definition:
vmxnet3.api:108
vl_api_vmxnet3_create_t::rxq_size
u16 rxq_size
Definition:
vmxnet3.api:38
vl_api_vmxnet3_details_t::rx_next
u16 rx_next
Definition:
vmxnet3.api:98
vl_api_vmxnet3_delete_t::client_index
u32 client_index
Definition:
vmxnet3.api:63
vl_api_vmxnet3_details_t::pci_addr
u32 pci_addr
Definition:
vmxnet3.api:92
vl_api_vmxnet3_details_t::sw_if_index
u32 sw_if_index
Definition:
vmxnet3.api:89
vl_api_vmxnet3_details_t::version
u8 version
Definition:
vmxnet3.api:93
u8
unsigned char u8
Definition:
types.h:56
vl_api_vmxnet3_create_t::client_index
u32 client_index
Definition:
vmxnet3.api:33
vl_api_vmxnet3_create_reply_t::context
u32 context
Definition:
vmxnet3.api:50
vl_api_vmxnet3_delete_t::sw_if_index
u32 sw_if_index
Definition:
vmxnet3.api:66
u32
unsigned int u32
Definition:
types.h:88
vl_api_vmxnet3_create_t::txq_size
u16 txq_size
Definition:
vmxnet3.api:39
version
option version
Definition:
vmxnet3.api:18
vl_api_vmxnet3_dump_t::context
u32 context
Definition:
vmxnet3.api:118
vl_api_vmxnet3_details_t::rx_qsize
u16 rx_qsize
Definition:
vmxnet3.api:96
u16
unsigned short u16
Definition:
types.h:57
vl_api_vmxnet3_create_reply_t::retval
i32 retval
Definition:
vmxnet3.api:51
vl_api_vmxnet3_details_t::context
u32 context
Definition:
vmxnet3.api:87
vl_api_vmxnet3_create_t::enable_elog
i32 enable_elog
Definition:
vmxnet3.api:37
i32
signed int i32
Definition:
types.h:77
vl_api_vmxnet3_details_t::tx_produce
u16 tx_produce
Definition:
vmxnet3.api:105
vl_api_vmxnet3_details_t::rx_qid
u16 rx_qid
Definition:
vmxnet3.api:95
vl_api_vmxnet3_create_t::pci_addr
u32 pci_addr
Definition:
vmxnet3.api:36
vl_api_vmxnet3_create_t::context
u32 context
Definition:
vmxnet3.api:34
vl_api_vmxnet3_dump_t::client_index
u32 client_index
Definition:
vmxnet3.api:117
vl_api_vmxnet3_create_reply_t::sw_if_index
u32 sw_if_index
Definition:
vmxnet3.api:52
vl_api_vmxnet3_details_t::tx_next
u16 tx_next
Definition:
vmxnet3.api:104
vl_api_vmxnet3_delete_t::context
u32 context
Definition:
vmxnet3.api:64
vl_api_vmxnet3_details_t::tx_qsize
u16 tx_qsize
Definition:
vmxnet3.api:103
vl_api_vmxnet3_details_t::tx_qid
u16 tx_qid
Definition:
vmxnet3.api:102
src
plugins
vmxnet3
vmxnet3.api
Generated on Mon Nov 25 2019 16:00:30 for FD.io VPP by
1.8.13