include/openflow/openflow-1.1.h

   1 /* Copyright (c) 2008, 2011, 2012 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 /*
  35  * Copyright (c) 2008, 2009, 2010, 2011 Nicira Networks.
  36  *
  37  * Licensed under the Apache License, Version 2.0 (the "License");
  38  * you may not use this file except in compliance with the License.
  39  * You may obtain a copy of the License at:
  40  *
  41  *     http://www.apache.org/licenses/LICENSE-2.0
  42  *
  43  * Unless required by applicable law or agreed to in writing, software
  44  * distributed under the License is distributed on an "AS IS" BASIS,
  45  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  46  * See the License for the specific language governing permissions and
  47  * limitations under the License.
  48  */
  49
  50 /* OpenFlow: protocol between controller and datapath. */
  51
  52 #ifndef OPENFLOW_11_H
  53 #define OPENFLOW_11_H 1
  54
  55 #include "openflow/openflow-common.h"
  56
  57 /* OpenFlow 1.1 uses 32-bit port numbers.  Open vSwitch, for now, uses OpenFlow
  58  * 1.0 port numbers internally.  We map them to OpenFlow 1.0 as follows:
  59  *
  60  * OF1.1                    <=>  OF1.0
  61  * -----------------------       ---------------
  62  * 0x00000000...0x0000feff  <=>  0x0000...0xfeff  "physical" ports
  63  * 0x0000ff00...0xfffffeff  <=>  not supported
  64  * 0xffffff00...0xffffffff  <=>  0xff00...0xffff  "reserved" OFPP_* ports
  65  *
  66  * OFPP11_OFFSET is the value that must be added or subtracted to convert
  67  * an OpenFlow 1.0 reserved port number to or from, respectively, the
  68  * corresponding OpenFlow 1.1 reserved port number.
  69  */
  70 #define OFPP11_MAX    0xffffff00
  71 #define OFPP11_OFFSET (OFPP11_MAX - OFPP_MAX)
  72
  73 /* OpenFlow 1.1 specific message types, in addition to the common message
  74  * types. */
  75 enum ofp11_type {
  76     /* Controller command messages. */
  77     OFPT11_PACKET_OUT = 13,     /* Controller/switch message */
  78     OFPT11_FLOW_MOD,            /* Controller/switch message */
  79     OFPT11_GROUP_MOD,           /* Controller/switch message */
  80     OFPT11_PORT_MOD,            /* Controller/switch message */
  81     OFPT11_TABLE_MOD,           /* Controller/switch message */
  82
  83     /* Statistics messages. */
  84     OFPT11_STATS_REQUEST,       /* Controller/switch message */
  85     OFPT11_STATS_REPLY,         /* Controller/switch message */
  86
  87     /* Barrier messages. */
  88     OFPT11_BARRIER_REQUEST,     /* Controller/switch message */
  89     OFPT11_BARRIER_REPLY,       /* Controller/switch message */
  90
  91     /* Queue Configuration messages. */
  92     OFPT11_QUEUE_GET_CONFIG_REQUEST,  /* Controller/switch message */
  93     OFPT11_QUEUE_GET_CONFIG_REPLY,    /* Controller/switch message */
  94 };
  95
  96 enum ofp11_action_type {
  97     OFPAT11_OUTPUT,           /* Output to switch port. */
  98     OFPAT11_SET_VLAN_VID,     /* Set the 802.1q VLAN id. */
  99     OFPAT11_SET_VLAN_PCP,     /* Set the 802.1q priority. */
 100     OFPAT11_SET_DL_SRC,       /* Ethernet source address. */
 101     OFPAT11_SET_DL_DST,       /* Ethernet destination address. */
 102     OFPAT11_SET_NW_SRC,       /* IP source address. */
 103     OFPAT11_SET_NW_DST,       /* IP destination address. */
 104     OFPAT11_SET_NW_TOS,       /* IP ToS (DSCP field, 6 bits). */
 105     OFPAT11_SET_NW_ECN,       /* IP ECN (2 bits). */
 106     OFPAT11_SET_TP_SRC,       /* TCP/UDP/SCTP source port. */
 107     OFPAT11_SET_TP_DST,       /* TCP/UDP/SCTP destination port. */
 108     OFPAT11_COPY_TTL_OUT,     /* Copy TTL "outwards" -- from next-to-outermost
 109                                  to outermost */
 110     OFPAT11_COPY_TTL_IN,      /* Copy TTL "inwards" -- from outermost to
 111                                next-to-outermost */
 112     OFPAT11_SET_MPLS_LABEL,   /* MPLS label */
 113     OFPAT11_SET_MPLS_TC,      /* MPLS TC */
 114     OFPAT11_SET_MPLS_TTL,     /* MPLS TTL */
 115     OFPAT11_DEC_MPLS_TTL,     /* Decrement MPLS TTL */
 116
 117     OFPAT11_PUSH_VLAN,        /* Push a new VLAN tag */
 118     OFPAT11_POP_VLAN,         /* Pop the outer VLAN tag */
 119     OFPAT11_PUSH_MPLS,        /* Push a new MPLS tag */
 120     OFPAT11_POP_MPLS,         /* Pop the outer MPLS tag */
 121     OFPAT11_SET_QUEUE,        /* Set queue id when outputting to a port */
 122     OFPAT11_GROUP,            /* Apply group. */
 123     OFPAT11_SET_NW_TTL,       /* IP TTL. */
 124     OFPAT11_DEC_NW_TTL,       /* Decrement IP TTL. */
 125     OFPAT11_EXPERIMENTER = 0xffff
 126 };
 127
 128 #endif /* openflow/openflow-1.1.h */