X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=openflow-protocol-api%2Fsrc%2Fmain%2Fyang%2Fopenflow-augments.yang;h=9a5454165f7df43254e7f109d4d1e9e44da6edee;hb=519a86d1ddcfb8f0fe264174e62e5424e1efba1f;hp=c7532b426eabb99901a724a401da93f5bc903b0d;hpb=b90d456133b70302a9b048c8f7e372b48ca1f093;p=openflowjava.git

diff --git a/openflow-protocol-api/src/main/yang/openflow-augments.yang b/openflow-protocol-api/src/main/yang/openflow-augments.yang
index c7532b42..9a545416 100644
--- a/openflow-protocol-api/src/main/yang/openflow-augments.yang
+++ b/openflow-protocol-api/src/main/yang/openflow-augments.yang
@@ -1,331 +1,407 @@
-module openflow-augments {
-    namespace "urn:opendaylight:openflow:augments";
-    prefix "aug";
-
-    import ietf-inet-types {prefix inet;}
-    import ietf-yang-types {prefix yang;}
-    
-    import openflow-types {prefix oft;}
-    import openflow-protocol {prefix ofproto;}
-    import openflow-action {prefix ofaction;}
-    import openflow-instruction {prefix ofinstruction;}
-    import openflow-extensible-match {prefix oxm;}
-
-
-    revision "2013-10-02" {
-        description "Initial model";
-    }
-// OFP_MATCH AUGMENTS
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf port-number {
-             type oft:port-number;
-         }
-     }
-
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf metadata {
-             type binary;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf mask {
-             type binary;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf mac-address {
-             type yang:mac-address;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf eth-type {
-             type oft:ether-type;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf vlan-vid {
-             type uint16;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf vlan-pcp {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf dscp {
-             type inet:dscp;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf ecn {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf protocol-number {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf ipv4-prefix {
-             type inet:ipv4-prefix;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf port {
-             type inet:port-number;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf icmpv4-type {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf icmpv4-code {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf op-code {
-             type uint16;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf ipv6-prefix {
-             type inet:ipv6-prefix;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf ipv6-flabel {
-             type inet:ipv6-flow-label;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf icmpv6-type {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf icmpv6-code {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf ipv6-address {
-             type inet:ipv6-address;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf mpls-label {
-             type uint32;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf tc {
-             type uint8;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf bos {
-             type boolean;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf isid {
-             type uint32;
-         }
-     }
-     
-     augment "/oxm:oxm-container/oxm:match-entries" {
-         leaf pseudo-field {
-             type bits {
-                 bit nonext {
-                     description "<No next header> encountered.";
-                     position 0;
-                 }
-                 bit esp {
-                     description "Encrypted Sec Payload header present.";
-                     position 1;
-                 }
-                 bit auth {
-                     description "Authentication header present.";
-                     position 2;
-                 }
-                 bit dest {
-                     description "1 or 2 dest headers present.";
-                     position 3;
-                 }
-                 bit frag {
-                     description "Fragment header present.";
-                     position 4;
-                 }
-                 bit router {
-                     description "Router header present.";
-                     position 5;
-                 }
-                 bit hop {
-                     description "Hop-by-hop header present.";
-                     position 6;
-                 }
-                 bit unrep {
-                     description "Unexpected repeats encountered.";
-                     position 7;
-                 }
-                 bit unseq {
-                     description "Unexpected sequencing encountered.";
-                     position 8;
-                     }                    
-             }
-         }
-     }
-
-// OFP_ACTION AUGMENTS
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf port {
-             type oft:any-port-number;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf max-length {
-             type uint16;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf mpls-ttl {
-             type uint8;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf ethertype {
-             type oft:ether-type;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf queue-id {
-             type uint32;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf group-id {
-             type uint32;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf nw-ttl {
-             type uint8;
-         }
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         uses oxm:oxm-fields;
-     }
-     
-     augment "/ofaction:actions-container/ofaction:action" {
-         leaf experimenter {
-             type uint32;
-         }
-     }
-
-// OFP_TABLE_FEATURES_PROPERTIES AUGMENTS
-     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
-         list instruction-ids {
-             uses ofinstruction:instructions;
-         }
-     }
-
-     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
-         list next-table-ids {
-             leaf table-id {
-                 type uint8;
-             }
-         }
-     }
-
-     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
-         list action-ids {
-             uses ofaction:action-header;
-         }
-     }
-
-     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
-         list oxm-ids {
-             uses oxm:oxm-fields;
-         }
-     }
-
-     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
-         leaf experimenter {
-             type uint32;
-         }
-         leaf exp-type {
-             type uint32;
-         }
-         leaf data {
-             type binary;
-         }
-     }
-     
-// OFP_INSTRUCTION AUGMENTS
-     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
-         leaf table-id {
-             type uint8;
-         }
-     }
-     
-     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
-         leaf metadata {
-             type binary;
-         }
-         leaf metadata-mask {
-             type binary;
-         }
-     }
-     
-     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
-         list actions {
-             uses ofaction:action-header;
-         }
-     }
-     
-     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
-         leaf meter-id {
-             type uint32;
-         }
-     }
-     
-     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
-         leaf experimenter {
-             type uint32;
-         }
-     }
+/*
+ * Copyright (c) 2013 Pantheon Technologies s.r.o. and others. All rights reserved.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v1.0 which accompanies this distribution,
+ * and is available at http://www.eclipse.org/legal/epl-v10.html
+ */
+ 
+ module openflow-augments {
+    namespace "urn:opendaylight:openflow:augments";
+    prefix "aug";
+    
+    import yang-ext {prefix ext;}
+    import ietf-inet-types {prefix inet;}
+    import ietf-yang-types {prefix yang;}
+
+    import openflow-types {prefix oft;}
+    import openflow-protocol {prefix ofproto;}
+    import openflow-action {prefix ofaction;}
+    import openflow-instruction {prefix ofinstruction;}
+    import openflow-extensible-match {prefix oxm;}
+
+    revision "2013-10-02" {
+        description "OpenFlow 1.3 - augments model. 
+                    Please visit 
+                    https://wiki.opendaylight.org/view/File:OpenFlow_Protocol_Library_-_Project_documentation.pdf
+                     - Augmentation Tables chapter";
+    }
+
+// OFP_MATCH AUGMENTS
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "port-number-match-entry";
+         leaf port-number {
+             type oft:port-number;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "metadata-match-entry";
+         leaf metadata {
+             type binary;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "mask-match-entry";
+         leaf mask {
+             type binary;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "mac-address-match-entry";
+         leaf mac-address {
+             type yang:mac-address;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "eth-type-match-entry";
+         leaf eth-type {
+             type oft:ether-type;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "vlan-vid-match-entry";
+         leaf vlan-vid {
+             type uint16;
+         }
+         leaf cfi-bit {
+             type boolean;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "vlan-pcp-match-entry";
+         leaf vlan-pcp {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "dscp-match-entry";
+         leaf dscp {
+             type inet:dscp;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "ecn-match-entry";
+         leaf ecn {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "protocol-number-match-entry";
+         leaf protocol-number {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "port-match-entry";
+         leaf port {
+             type inet:port-number;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "icmpv4-type-match-entry";
+         leaf icmpv4-type {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "icmpv4-code-match-entry";
+         leaf icmpv4-code {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "op-code-match-entry";
+         leaf op-code {
+             type uint16;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "ipv6-flabel-match-entry";
+         leaf ipv6-flabel {
+             type inet:ipv6-flow-label;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "icmpv6-type-match-entry";
+         leaf icmpv6-type {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "icmpv6-code-match-entry";
+         leaf icmpv6-code {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "ipv6-address-match-entry";
+         leaf ipv6-address {
+             type inet:ipv6-address;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "ipv4-address-match-entry";
+         leaf ipv4-address {
+             type inet:ipv4-address;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "mpls-label-match-entry";
+         leaf mpls-label {
+             type uint32;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "tc-match-entry";
+         leaf tc {
+             type uint8;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "bos-match-entry";
+         leaf bos {
+             type boolean;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "isid-match-entry";
+         leaf isid {
+             type uint32;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "pseudo-field-match-entry";
+         leaf pseudo-field {
+             type oft:ipv6-exthdr-flags;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "experimenter-id-match-entry";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "tcp-flag-match-entry";
+         leaf tcp-flag {
+             type uint16;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "tunnel-ipv4-dst-match-entry";
+         leaf tunnel-ipv4-dst {
+             type inet:ipv4-address;
+         }
+     }
+     augment "/oxm:oxm-container/oxm:match-entries" {
+         ext:augment-identifier "tunnel-ipv4-src-match-entry";
+         leaf tunnel-ipv4-src {
+             type inet:ipv4-address;
+         }
+     }
+
+// OFP_ACTION AUGMENTS
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "port-action";
+         leaf port {
+             type oft:port-number;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "max-length-action";
+         leaf max-length {
+             type uint16;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "mpls-ttl-action";
+         leaf mpls-ttl {
+             type uint8;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "ethertype-action";
+         leaf ethertype {
+             type oft:ether-type;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "queue-id-action";
+         leaf queue-id {
+             type uint32;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "group-id-action";
+         leaf group-id {
+             type uint32;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "nw-ttl-action";
+         leaf nw-ttl {
+             type uint8;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "oxm-fields-action";
+         uses oxm:oxm-fields-grouping;
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "experimenter-id-action";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+         leaf sub-type {
+            type identityref {
+                base ofaction:experimenter-action-sub-type;
+            }
+         }
+     }
+     // OF1.0 structures
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "vlan-vid-action";
+         leaf vlan-vid {
+             type uint16;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "vlan-pcp-action";
+         leaf vlan-pcp {
+             type uint8;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "dl-address-action";
+         leaf dl-address {
+             type yang:mac-address;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "nw-tos-action";
+         leaf nw-tos {
+             type uint8;
+         }
+     }
+     augment "/ofaction:actions-container/ofaction:action" {
+         ext:augment-identifier "ip-address-action";
+         leaf ip-address {
+             type inet:ipv4-address;
+         }
+     }
+
+// OFP_TABLE_FEATURES_PROPERTIES AUGMENTS
+     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
+         ext:augment-identifier "instruction-related-table-feature-property";
+         uses ofinstruction:instructions-grouping;
+     }
+     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
+         ext:augment-identifier "next-table-related-table-feature-property";
+         list next-table-ids {
+             config false;
+             leaf table-id {
+                 type uint8;
+             }
+         }
+     }
+     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
+         ext:augment-identifier "action-related-table-feature-property";
+         uses ofaction:actions-grouping;
+     }
+     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
+         ext:augment-identifier "oxm-related-table-feature-property";
+         uses oxm:oxm-fields-grouping;
+     }
+     augment "/ofproto:table-features-properties-container/ofproto:table-feature-properties" {
+         ext:augment-identifier "experimenter-id-table-feature-property";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+         leaf exp-type {
+             type uint32;
+         }
+     }
+
+// OFP_INSTRUCTION AUGMENTS
+     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
+         ext:augment-identifier "table-id-instruction";
+         leaf table-id {
+             type uint8;
+         }
+     }
+     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
+         ext:augment-identifier "metadata-instruction";
+         leaf metadata {
+             type binary;
+         }
+         leaf metadata-mask {
+             type binary;
+         }
+     }
+     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
+         ext:augment-identifier "actions-instruction";
+         uses ofaction:actions-grouping;
+     }
+     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
+         ext:augment-identifier "meter-id-instruction";
+         leaf meter-id {
+             type uint32;
+         }
+     }
+     augment "/ofinstruction:instruction-container/ofinstruction:instruction" {
+         ext:augment-identifier "experimenter-id-instruction";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+     }
+     
+// OFP_QUEUE_PROP AUGMENTS
+     augment "/ofproto:queue-prop-container/ofproto:queue-property" {
+         ext:augment-identifier "rate-queue-property";
+         leaf rate {
+             type uint16;
+         }
+     }
+     augment "/ofproto:queue-prop-container/ofproto:queue-property" {
+         ext:augment-identifier "experimenter-id-queue-property";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+     }
+     
+// OFP_ERROR_AUGMENTS (only experimenter till OpenFlow v1.3)
+     augment "/ofproto:error-message" {
+         ext:augment-identifier "experimenter-id-error";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+     }
+
+// OFP_MULTIPART AUGMENTS
+     augment "/ofproto:multipart-request/input/ofproto:multipart-request-body/ofproto:multipart-request-experimenter-case/ofproto:multipart-request-experimenter" {
+         ext:augment-identifier "experimenter-id-multipart-request";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+         leaf exp-type {
+             type uint32;
+         }
+     }
+     augment "/ofproto:multipart-reply-message/ofproto:multipart-reply-body/ofproto:multipart-reply-experimenter-case/ofproto:multipart-reply-experimenter" {
+         ext:augment-identifier "experimenter-id-multipart-reply";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+         leaf exp-type {
+             type uint32;
+         }
+     }
+
+// OFP_METER_BAND AUGMENTS
+     augment "/ofproto:meter-band-container/ofproto:meter-band/ofproto:meter-band-experimenter-case/ofproto:meter-band-experimenter" {
+         ext:augment-identifier "experimenter-id-meter-band";
+         leaf experimenter {
+             type oft:experimenter-id;
+         }
+     }
 }
\ No newline at end of file