module bbf-frame-classification {

    yang-version 1.1;

    namespace
      "urn:bbf:yang:bbf-frame-classification";

    prefix bbf-classif;

    import ietf-yang-types {
      prefix yang;
    }
    import ietf-inet-types {
      prefix inet;
    }
    import bbf-yang-types {
      prefix bbf-yang;
    }
    import bbf-dot1q-types {
      prefix bbf-dot1qt;
    }
    import bbf-inet-types {
      prefix bbf-inet;
    }

    organization
      "Broadband Forum <https://www.broadband-forum.org>
Common YANG Work Area";

    contact
      "Comments or questions about this Broadband Forum YANG module
should be directed to <mailto:help@broadband-forum.org>.

Editor:      Nick Hancock, ADTRAN

Editor:      Ludwig Pauwels, Nokia

PS Leader:   Joey Boyd, ADTRAN

WA Director: Joey Boyd, ADTRAN

WA Director: Sven Ooghe, Nokia";

    description
      "This module contains a collection of YANG definitions for
supporting the Broadband Forum requirements on frame
classification as applicable to access network equipment. As
such, this module is specific to access network equipment (e.g.,
BBF-specified Access Nodes and FTTdp DPUs).

Specifically, this module contains reusable groupings defined for
frame classification.

Copyright (c) 2017-2022, Broadband Forum

Redistribution and use in source and binary forms, with or
without modification, are permitted provided that the following
conditions are met:

1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following
   disclaimer in the documentation and/or other materials
   provided with the distribution.

3. Neither the name of the copyright holder nor the names of its
   contributors may be used to endorse or promote products
   derived from this software without specific prior written
   permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The above license is used as a license under copyright only.
Please reference the Forum IPR Policy for patent licensing terms
<https://www.broadband-forum.org/ipr-policy>.

Any moral rights which are necessary to exercise under the above
license grant are also deemed granted under this license.

This version of this YANG module is part of TR-383a5; see
the TR itself for full legal notices.";

    revision "2022-03-01" {
      description
        "Amendment 5.
* Approval Date:    2022-03-01.
* Publication Date: 2022-03-01.";
      reference
        "TR-383a5: Common YANG Modules
        	  <https://www.broadband-forum.org/technical/download/
        		   TR-383_Amendment-5.pdf>";

    }

    revision "2021-06-02" {
      description
        "Amendment 4.
* Approval Date:    2021-06-02.
* Publication Date: 2021-06-02.";
      reference
        "TR-383a4: Common YANG Modules
        	  <https://www.broadband-forum.org/technical/download/
        		   TR-383_Amendment-4.pdf>";

    }

    revision "2020-10-13" {
      description
        "Amendment 3.
* Approval Date:    2020-10-13.
* Publication Date: 2020-10-13.";
      reference
        "TR-383a3: Common YANG Modules
        	  <https://www.broadband-forum.org/technical/download/
        		   TR-383_Amendment-3.pdf>";

    }

    revision "2018-07-13" {
      description
        "Amendment 1.
* Approval Date:    2018-06-04.
* Publication Date: see revision date above.";
      reference
        "TR-383: Common YANG Modules
        	<https://www.broadband-forum.org/technical/download/
        		 TR-383_Amendment-1.pdf>";

    }

    revision "2017-05-08" {
      description
        "Initial revision.
* Approval Date:    see revision date above.
* Publication Date: 2017-06-02.";
      reference
        "TR-383: Common YANG Modules
        	<https://www.broadband-forum.org/technical/download/
        		 TR-383.pdf>";

    }


    feature filter-on-ip-prefix {
      description
        "This feature indicates whether the network element supports
filtering IPv4 and/or IPv6 packets based on configured
prefixes.";
    }

    typedef protocols {
      type enumeration {
        enum "igmp" {
          value 0;
          description
            "Identifies IPv4 IGMP messages, i.e. the IPv4 packets for
which in the IPv4 header the protocol field is set to the
value 0x02.";
        }
        enum "mld" {
          value 1;
          description
            "Identifies IPv6 MLD messages, MLD messages are a subset of
the ICMPv6 protocol. ICMPv6 messages are identified with
Next Header value of 58. MLD messages are identified by
specific values of the Type field. Type field values are
defined in RFC 3810.";
        }
        enum "dhcpv4" {
          value 2;
          description
            "Identifies IPv4 packets with UDP source port 68 and
destination port 67 (client to server), or with UDP source
port 67 and destination port 68 (server to client).";
        }
        enum "dhcpv6" {
          value 3;
          description
            "Identifies IPv6 packets with UDP source port 547 and
destination port 546 (client to server), or with UDP source
port 546 and destination port 547 (server to client).";
        }
        enum "pppoe-discovery" {
          value 4;
          description
            "Identifies PPPoE discovery messages, which are Ethernet
frames with Ethertype=0x8863.";
        }
        enum "icmpv6" {
          value 5;
          description
            "Identifies ICMPv6 protocol messages. ICMPv6 messages are
identified with Next Header value of 58. When the
individual ICMPv6 message types are configured then the
individual configurations will take precedence over this
configuration.";
        }
        enum "nd" {
          value 6;
          description
            "Identifies IPv6 ND messages, ND messages are a subset of
the ICMPv6 protocol. ICMPv6 messages are identified with
Next Header value of 58. ND messages are identified by
specific values of the Type field. Type field values are
defined in RFC 3810.";
        }
        enum "arp" {
          value 7;
          description
            "Identifies the ARP messages, which are Ethernet frames with
ethertype 0x0806.";
        }
        enum "cfm" {
          value 8;
          description
            "Identifies the CFM messages, which are Ethernet frames with
ethertype 0x8902.";
        }
        enum "dot1x" {
          value 9;
          description
            "Identifies the DOT1X messages, which are Ethernet frames
with ethertype 0x888E.";
        }
        enum "lacp" {
          value 10;
          description
            "Identifies the LACP messages, which are Ethernet frames
with ethertype 0x8809.";
        }
      }
      description
        "Enumerated list of protocols.";
    }

    typedef dscp-range-or-any {
      type union {
        type bbf-inet:dscp-range;
        type enumeration {
          enum "any" {
            value 0;
            description
              "Matches any DSCP value in the range of 0 to 63.";
          }
        }
      }
      description
        "Specifies a range of DSCP values. A special value 'any'
allows for any DSCP value.";
    }

    typedef tag-index {
      type uint8 {
        range "0..1";
      }
      description
        "The index of the VLAN tag in a frame.
- Tag 0 refers to the outer tag, i.e. the tag just after the
source MAC address.
- Tag 1 refers to the tag after tag 0.";
    }
  }  // module bbf-frame-classification