Update copyright on all non-GPL files
[openvswitch] / include / openflow-netlink.h
1 /* Copyright (c) 2008 The Board of Trustees of The Leland Stanford
2  * Junior University
3  * 
4  * We are making the OpenFlow specification and associated documentation
5  * (Software) available for public use and benefit with the expectation
6  * that others will use, modify and enhance the Software and contribute
7  * those enhancements back to the community. However, since we would
8  * like to make the Software available for broadest use, with as few
9  * restrictions as possible permission is hereby granted, free of
10  * charge, to any person obtaining a copy of this Software to deal in
11  * the Software under the copyrights without restriction, including
12  * without limitation the rights to use, copy, modify, merge, publish,
13  * distribute, sublicense, and/or sell copies of the Software, and to
14  * permit persons to whom the Software is furnished to do so, subject to
15  * the following conditions:
16  * 
17  * The above copyright notice and this permission notice shall be
18  * included in all copies or substantial portions of the Software.
19  * 
20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
21  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
23  * NONINFRINGEMENT.  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
24  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
25  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
26  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27  * SOFTWARE.
28  * 
29  * The name and trademarks of copyright holder(s) may NOT be used in
30  * advertising or publicity pertaining to the Software or any
31  * derivatives without specific, written prior permission.
32  */
33
34 #ifndef OPENFLOW_NETLINK_H
35 #define OPENFLOW_NETLINK_H 1
36
37 #include <linux/netlink.h>
38
39 #define DP_GENL_FAMILY_NAME "OpenFlow"
40
41 /* Attributes that can be attached to the datapath's netlink messages. */
42 enum {
43         DP_GENL_A_UNSPEC,
44     DP_GENL_A_OFPHEADER, /* OFP header information */
45         DP_GENL_A_DP_IDX,        /* Datapath Ethernet device name. */
46         DP_GENL_A_PORTNAME,      /* Device name for datapath port. */
47         DP_GENL_A_MC_GROUP,      /* Generic netlink multicast group. */
48         DP_GENL_A_OPENFLOW,  /* OpenFlow packet. */
49
50     DP_GENL_A_DP_INFO,   /* OpenFlow datapath information */
51
52     DP_GENL_A_FLOW,      /* OpenFlow flow entry */
53     DP_GENL_A_NUMFLOWS,  /* Number of flows  */
54     DP_GENL_A_TABLEIDX,  /* Flow table index */
55
56     DP_GENL_A_TABLE,     /* OpenFlow table entry */
57     DP_GENL_A_NUMTABLES, /* Number of tables in a table query */
58
59     DP_GENL_A_NPACKETS,  /* Number of packets to send up netlink */
60     DP_GENL_A_PSIZE,     /* Size of packets to send up netlink */
61
62         __DP_GENL_A_MAX,
63         DP_GENL_A_MAX = __DP_GENL_A_MAX - 1
64 };
65
66 /* Commands that can be executed on the datapath's netlink interface. */
67 enum dp_genl_command {
68         DP_GENL_C_UNSPEC,
69         DP_GENL_C_ADD_DP,        /* Create datapath. */
70         DP_GENL_C_DEL_DP,        /* Destroy datapath. */
71         DP_GENL_C_QUERY_DP,      /* Get multicast group for datapath. */
72         DP_GENL_C_SHOW_DP,       /* Show information about datapath. */
73         DP_GENL_C_ADD_PORT,      /* Add port to datapath. */
74         DP_GENL_C_DEL_PORT,      /* Remove port from datapath. */
75         DP_GENL_C_OPENFLOW,  /* Encapsulated OpenFlow protocol. */
76
77     DP_GENL_C_QUERY_FLOW,  /* Request flow entries. */
78     DP_GENL_C_QUERY_TABLE, /* Request table entries. */
79
80     DP_GENL_C_BENCHMARK_NL, /* Benchmark netlink connection */
81
82         __DP_GENL_C_MAX,
83         DP_GENL_C_MAX = __DP_GENL_C_MAX - 1
84 };
85
86 /* Table */
87 enum {
88     TBL_MACONLY,
89     TBL_HASH,
90     TBL_LINEAR,
91      __TBL_MAX,
92      TBL_MAX = __TBL_MAX - 1
93 };
94
95 #endif /* openflow_netlink_h */