2 * Copyright (c) 2017 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:
7 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 /** \brief Create memory interface
19 @param client_index - opaque cookie to identify the sender
20 @param context - sender context, to match reply w/ request
21 @param role - role of the interface in the connection (master/slave)
22 @param mode - interface mode
23 @param rx_queues - number of rx queues (only valid for slave)
24 #param tx_queues - number of tx queues (only valid for slave)
25 @param id - 32bit integer used to authenticate and match opposite sides
27 @param socket_filename - filename of the socket to be used for connection
29 @param ring_size - the number of entries of RX/TX rings
30 @param buffer_size - size of the buffer allocated for each ring entry
31 @param hw_addr - interface MAC address
38 u8 role; /* 0 = master, 1 = slave */
39 u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
40 u8 rx_queues; /* optional, default is 1 */
41 u8 tx_queues; /* optional, default is 1 */
42 u32 id; /* optional, default is 0 */
43 u8 socket_filename[128]; /* optional, default is "/var/vpp/memif.sock" */
44 u8 secret[24]; /* optional, default is "" */
45 u32 ring_size; /* optional, default is 1024 entries, must be power of 2 */
46 u16 buffer_size; /* optional, default is 2048 bytes */
47 u8 hw_addr[6]; /* optional, randomly generated if not defined */
50 /** \brief Create memory interface response
51 @param context - sender context, to match reply w/ request
52 @param retval - return value for request
53 @param sw_if_index - software index of the newly created interface
55 define memif_create_reply
62 /** \brief Delete memory interface
63 @param client_index - opaque cookie to identify the sender
64 @param context - sender context, to match reply w/ request
65 @param sw_if_index - software index of the interface to delete
67 autoreply define memif_delete
75 /** \brief Memory interface details structure
76 @param context - sender context, to match reply w/ request (memif_dump)
77 @param sw_if_index - index of the interface
78 @param if_name - name of the interface
79 @param hw_addr - interface MAC address
80 @param id - id associated with the interface
81 @param role - role of the interface in the connection (master/slave)
82 @param mode - interface mode
83 @param socket_filename - name of the socket used by this interface
84 to establish new connections
85 @param ring_size - the number of entries of RX/TX rings
86 @param buffer_size - size of the buffer allocated for each ring entry
87 @param admin_up_down - interface administrative status
88 @param link_up_down - interface link status
99 /* memif specific parameters */
101 u8 role; /* 0 = master, 1 = slave */
102 u8 mode; /* 0 = ethernet, 1 = ip, 2 = punt/inject */
103 u8 socket_filename[128];
105 u16 buffer_size; /* optional, default is 2048 bytes */
107 /* 1 = up, 0 = down */
112 /** \brief Dump all memory interfaces
113 @param client_index - opaque cookie to identify the sender
114 @param context - sender context, to match reply w/ request
124 * eval: (c-set-style "gnu")