FD.io VPP  v19.04.4-rc0-5-ge88582fac
Vector Packet Processing
pppoe.api
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017 Intel 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 option version = "1.0.0";
17 
18 /** \brief Set or delete an PPPOE session
19  @param client_index - opaque cookie to identify the sender
20  @param context - sender context, to match reply w/ request
21  @param is_add - add address if non-zero, else delete
22  @param is_ipv6 - client_ip and dst_address is ipv6 or not
23  @param session_id - PPPoE session ID
24  @param client_ip - PPPOE session's client address.
25  @param decap_vrf_id - the vrf index for pppoe decaped packet
26  @param client_mac - the client ethernet address
27 */
28 define pppoe_add_del_session
29 {
35  u8 client_ip[16];
37  u8 client_mac[6];
38 };
39 
40 /** \brief reply for set or delete an PPPOE session
41  @param context - sender context, to match reply w/ request
42  @param retval - return code
43  @param sw_if_index - software index of the interface
44 */
45 define pppoe_add_del_session_reply
46 {
50 };
51 
52 /** \brief Dump PPPOE session
53  @param client_index - opaque cookie to identify the sender
54  @param context - sender context, to match reply w/ request
55  @param sw_if_index - software index of the interface
56 */
57 define pppoe_session_dump
58 {
62 };
63 
64 /** \brief dump details of an PPPOE session
65  @param context - sender context, to match reply w/ request
66  @param sw_if_index - software index of the interface
67  @param is_ipv6 - client_ip and dst_address is ipv6 or not
68  @param session_id - PPPoE session ID
69  @param client_ip - PPPOE session's client address.
70  @param encap_if_index - the index of tx interface for pppoe encaped packet
71  @param decap_vrf_id - the vrf index for pppoe decaped packet
72  @param local_mac - the local ethernet address
73  @param client_mac - the client ethernet address
74 */
75 define pppoe_session_details
76 {
81  u8 client_ip[16];
84  u8 local_mac[6];
85  u8 client_mac[6];
86 };
87 
88 /*
89  * Local Variables:
90  * eval: (c-set-style "gnu")
91  * End:
92  */
option version
Definition: pppoe.api:16
unsigned char u8
Definition: types.h:56
unsigned int u32
Definition: types.h:88
unsigned short u16
Definition: types.h:57
signed int i32
Definition: types.h:77