ofproto: Mark NXT_ACT_SET_CONFIG and NXT_ACT_GET_CONFIG obsolete.
[openvswitch] / include / openflow / nicira-ext.h
1 /*
2  * Copyright (c) 2008, 2009, 2010 Nicira Networks
3  *
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 #ifndef OPENFLOW_NICIRA_EXT_H
18 #define OPENFLOW_NICIRA_EXT_H 1
19
20 #include "openflow/openflow.h"
21
22 #define NICIRA_OUI_STR "002320"
23
24 /* The following vendor extensions, proposed by Nicira Networks, are not yet
25  * ready for standardization (and may never be), so they are not included in
26  * openflow.h. */
27
28 #define NX_VENDOR_ID 0x00002320
29
30 enum nicira_type {
31     /* Switch status request.  The request body is an ASCII string that
32      * specifies a prefix of the key names to include in the output; if it is
33      * the null string, then all key-value pairs are included. */
34     NXT_STATUS_REQUEST,
35
36     /* Switch status reply.  The reply body is an ASCII string of key-value
37      * pairs in the form "key=value\n". */
38     NXT_STATUS_REPLY,
39
40     /* No longer used. */
41     NXT_ACT_SET_CONFIG__OBSOLETE,
42
43     /* No longer used. */
44     NXT_ACT_GET_CONFIG__OBSOLETE,
45
46     /* No longer used. */
47     NXT_COMMAND_REQUEST__OBSOLETE,
48
49     /* No longer used. */
50     NXT_COMMAND_REPLY__OBSOLETE,
51
52     /* No longer used. */
53     NXT_FLOW_END_CONFIG__OBSOLETE,
54
55     /* No longer used. */
56     NXT_FLOW_END__OBSOLETE,
57
58     /* No longer used. */
59     NXT_MGMT__OBSOLETE,
60 };
61
62 struct nicira_header {
63     struct ofp_header header;
64     uint32_t vendor;            /* NX_VENDOR_ID. */
65     uint32_t subtype;           /* One of NXT_* above. */
66 };
67 OFP_ASSERT(sizeof(struct nicira_header) == 16);
68
69
70 enum nx_action_subtype {
71     NXAST_SNAT__OBSOLETE,           /* No longer used. */
72     NXAST_RESUBMIT                  /* Throw against flow table again. */
73 };
74
75 /* Action structure for NXAST_RESUBMIT. */
76 struct nx_action_resubmit {
77     uint16_t type;                  /* OFPAT_VENDOR. */
78     uint16_t len;                   /* Length is 8. */
79     uint32_t vendor;                /* NX_VENDOR_ID. */
80     uint16_t subtype;               /* NXAST_RESUBMIT. */
81     uint16_t in_port;               /* New in_port for checking flow table. */
82     uint8_t pad[4];
83 };
84 OFP_ASSERT(sizeof(struct nx_action_resubmit) == 16);
85
86 /* Header for Nicira-defined actions. */
87 struct nx_action_header {
88     uint16_t type;                  /* OFPAT_VENDOR. */
89     uint16_t len;                   /* Length is 8. */
90     uint32_t vendor;                /* NX_VENDOR_ID. */
91     uint16_t subtype;               /* NXAST_*. */
92     uint8_t pad[6];
93 };
94 OFP_ASSERT(sizeof(struct nx_action_header) == 16);
95
96 #endif /* openflow/nicira-ext.h */