module bbf-qos-filters {

    yang-version 1.1;

    namespace "urn:bbf:yang:bbf-qos-filters";

    prefix bbf-qos-filt;

    import bbf-yang-types {
      prefix bbf-yang;
    }
    import bbf-qos-classifiers {
      prefix bbf-qos-cls;
    }
    import bbf-frame-classification {
      prefix bbf-classif;
    }

    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 the management of
     Quality of Service (QoS) 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 definitions of filter
     criteria.

     Copyright (c) 2017-2023, 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-383a7; see
     the TR itself for full legal notices.";

    revision "2023-12-15" {
      description
        "Amendment 7.
       * Approval Date:    2023-12-15.
       * Publication Date: 2023-12-15.";
      reference
        "TR-383a7: Common YANG Modules
        	  <https://www.broadband-forum.org/technical/download/
        		   TR-383_Amendment-7.pdf>";

    }

    revision "2023-03-07" {
      description
        "Amendment 6.
       * Approval Date:    2023-03-07.
       * Publication Date: 2023-03-07.";
      reference
        "TR-383a6: Common YANG Modules
        	  <https://www.broadband-forum.org/technical/download/
        		   TR-383_Amendment-6.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>";

    }


    container filters {
      description "Filters configuration.";
      list filter {
        key "name";
        description "A filter.";
        leaf name {
          type bbf-yang:string-ascii64;
          description "Filter name.";
        }

        leaf description {
          type bbf-yang:string-ascii64-or-empty;
          description
            "Description of the filter.";
        }

        leaf filter-match {
          type boolean;
          default "true";
          description
            "This is logical operator for a filter.

           If 'true', it indicates the filter looks for a match with a
           pattern defined by the filter-field.

           If 'false', it looks for a 'no match' with the pattern
           defined by the filter field.";
        }

        choice filter-field {
          description
            "A field to be classified.";
          container source-mac-address {
            description
              "Filter containing source MAC address.";
            choice mac-address {
              description
                "A choice on the value of the MAC address.";
              case any-multicast-mac-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as a multicast MAC address.";
                leaf any-multicast-mac-address {
                  type empty;
                  description
                    "The MAC address is classified as a multicast address,
i.e., it is an address for which the least significant
bit of the first octet is set to 1.";
                }
              }  // case any-multicast-mac-address

              case unicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as a unicast address.";
                leaf unicast-address {
                  type empty;
                  description
                    "The MAC address is classified as a unicast address, i.e.,
it is an address for which the least significant bit of
the first octet is set to 0 (zero).";
                }
              }  // case unicast-address

              case broadcast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as the broadcast address.";
                leaf broadcast-address {
                  type empty;
                  description
                    "The MAC address is classified as a broadcast address,
i.e., address FF:FF:FF:FF:FF:FF.";
                }
              }  // case broadcast-address

              case cfm-multicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as a CFM OAM multicast address.";
                leaf cfm-multicast-address {
                  type empty;
                  description
                    "The MAC address is classified as a CFM multicast address,
i.e., it is an address of the form 01:80:C2:00:00:3X.";
                  reference
                    "IEEE 802.1Q-2014 Clause 8.13.11";

                }
              }  // case cfm-multicast-address

              case ipv4-multicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as an IPv4 multicast address.";
                leaf ipv4-multicast-address {
                  type empty;
                  description
                    "The MAC address is classified as an IPv4 multicast
address, i.e., it is an address in the range
01:00:5E:00:00:00 up to and including
01:00:5E:7F:FF:FF.";
                }
              }  // case ipv4-multicast-address

              case ipv6-multicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as an IPv6 multicast address.";
                leaf ipv6-multicast-address {
                  type empty;
                  description
                    "The MAC address is classified as an IPv6 multicast
address, i.e., it is an address of the form
33:33:XX:XX:XX:XX.";
                }
              }  // case ipv6-multicast-address

              case mac-address-filter {
                description
                  "The value and the mask together identify a set of MAC
addresses that comply with this classification. Evaluation
is performed by making a bit-wise AND operation between the
to be evaluated MAC address and the mac-address-mask. There
is a match if the result equals the value specified in the
mac-address-value.";
                leaf mac-address-value {
                  type yang:mac-address;
                  description
                    "The value with which a comparison shall be made after
performing the bit-wise AND operation on the to be
evaluated MAC address.";
                }

                leaf mac-address-mask {
                  type yang:mac-address;
                  default
                    "FF:FF:FF:FF:FF:FF";
                  description
                    "A mask to be applied on the to be evaluated MAC address.
The mask is applied as a bit-wise AND operation.";
                }
              }  // case mac-address-filter
            }  // choice mac-address
          }  // container source-mac-address
          container destination-mac-address {
            description
              "Filter containing destination MAC address.";
            choice mac-address {
              description
                "A choice on the value of the MAC address.";
              case any-multicast-mac-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as a multicast MAC address.";
                leaf any-multicast-mac-address {
                  type empty;
                  description
                    "The MAC address is classified as a multicast address,
i.e., it is an address for which the least significant
bit of the first octet is set to 1.";
                }
              }  // case any-multicast-mac-address

              case unicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as a unicast address.";
                leaf unicast-address {
                  type empty;
                  description
                    "The MAC address is classified as a unicast address, i.e.,
it is an address for which the least significant bit of
the first octet is set to 0 (zero).";
                }
              }  // case unicast-address

              case broadcast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as the broadcast address.";
                leaf broadcast-address {
                  type empty;
                  description
                    "The MAC address is classified as a broadcast address,
i.e., address FF:FF:FF:FF:FF:FF.";
                }
              }  // case broadcast-address

              case cfm-multicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as a CFM OAM multicast address.";
                leaf cfm-multicast-address {
                  type empty;
                  description
                    "The MAC address is classified as a CFM multicast address,
i.e., it is an address of the form 01:80:C2:00:00:3X.";
                  reference
                    "IEEE 802.1Q-2014 Clause 8.13.11";

                }
              }  // case cfm-multicast-address

              case ipv4-multicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as an IPv4 multicast address.";
                leaf ipv4-multicast-address {
                  type empty;
                  description
                    "The MAC address is classified as an IPv4 multicast
address, i.e., it is an address in the range
01:00:5E:00:00:00 up to and including
01:00:5E:7F:FF:FF.";
                }
              }  // case ipv4-multicast-address

              case ipv6-multicast-address {
                description
                  "This case applies when the to-be-classified MAC address is
classified as an IPv6 multicast address.";
                leaf ipv6-multicast-address {
                  type empty;
                  description
                    "The MAC address is classified as an IPv6 multicast
address, i.e., it is an address of the form
33:33:XX:XX:XX:XX.";
                }
              }  // case ipv6-multicast-address

              case mac-address-filter {
                description
                  "The value and the mask together identify a set of MAC
addresses that comply with this classification. Evaluation
is performed by making a bit-wise AND operation between the
to be evaluated MAC address and the mac-address-mask. There
is a match if the result equals the value specified in the
mac-address-value.";
                leaf mac-address-value {
                  type yang:mac-address;
                  description
                    "The value with which a comparison shall be made after
performing the bit-wise AND operation on the to be
evaluated MAC address.";
                }

                leaf mac-address-mask {
                  type yang:mac-address;
                  default
                    "FF:FF:FF:FF:FF:FF";
                  description
                    "A mask to be applied on the to be evaluated MAC address.
The mask is applied as a bit-wise AND operation.";
                }
              }  // case mac-address-filter
            }  // choice mac-address
          }  // container destination-mac-address
        }  // choice filter-field
      }  // list filter
    }  // container filters
  }  // module bbf-qos-filters