module bbf-qos-traffic-mngt {

    yang-version 1.1;

    namespace
      "urn:bbf:yang:bbf-qos-traffic-mngt";

    prefix bbf-qos-tm;

    import ietf-interfaces {
      prefix if;
    }
    import ietf-yang-types {
      prefix yang;
    }
    import bbf-yang-types {
      prefix bbf-yang;
    }
    import bbf-qos-types {
      prefix bbf-qos-t;
    }

    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 a collection of functions for
QoS traffic management (TM).

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-12-03" {
      description
        "Amendment 2.
* Approval Date:    2018-12-03.
* Publication Date: 2018-12-03.";
      reference
        "TR-383a2: Common YANG Modules
        	<https://www.broadband-forum.org/technical/download/
        		 TR-383_Amendment-2.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 pre-emption {
      description
        "This feature indicates whether the network element supports
pre-emption.";
    }

    feature tc-id-2-queue-id-mapping-config {
      description
        "This feature indicates whether the network element supports
configuring traffic-class-id to queue-id mapping profiles.";
    }

    feature extended-scheduling-weight {
      description
        "Indicates support for extending the maximum weight value from
255 to 65535.";
    }

    feature dual-rate-scheduling-from-queue {
      description
        "Indicates support for dual rate scheduling, i.e. configuring
from a parent scheduler a separate priority and/or weight
for the CIR and EIR traffic from a single child scheduler.";
    }

    feature queue-statistics {
      description
        "Indicates support for reporting statistics per queue.";
    }

    typedef queue-id {
      type uint32 {
        range "0..7";
      }
      description
        "An integer number identifying a queue within the context from
which traffic will be scheduled. It is an abstract identifier:
its value does NOT represent the priority of the queue itself.
This queue-id value is determined by means of a
traffic-class-id to queue-id mapping profile.";
    }

    typedef scheduling-priority {
      type uint8 {
        range "0..7";
      }
      description
        "This number represents the priority of the queue or a scheduler
competing with others in the context of scheduling traffic.
Value 7 means highest priority and 0 means lowest priority.";
    }

    typedef extended-scheduling-priority {
      type uint8 {
        range "0..15";
      }
      description
        "This number represents the priority of the queue or a scheduler
competing with others in the context of scheduling traffic.
Value 15 means highest priority and 0 means lowest priority.";
    }

    typedef scheduling-weight {
      type uint8;
      description
        "If scheduling is to be performed from multiple queues or
schedulers with the same priority, then the scheduling-weight
assigns a weight to each of them.";
    }

    typedef extended-scheduling-weight {
      type uint16;
      description
        "If scheduling is to be performed from multiple queues or
schedulers with the same priority, then the scheduling-weight
assigns a weight to each of them.";
    }

    identity bac-type {
      description
        "Base identity of a Buffer Acceptance Control (BAC) type.";
    }

    identity taildrop {
      base bac-type;
      description "Taildrop BAC type.";
    }

    identity red {
      base bac-type;
      description
        "Random Early Detection (RED) BAC type.";
    }

    identity wtaildrop {
      base bac-type;
      description
        "Weighted taildrop BAC type.";
    }

    identity wred {
      base bac-type;
      description
        "Weighted Random Early Detection (WRED) BAC type.";
    }

    container tm-profiles {
      description
        "A set of types of profiles for traffic management
configuration.";
      list tc-id-2-queue-id-mapping-profile {
        if-feature tc-id-2-queue-id-mapping-config;
        key "name";
        description
          "A traffic-class-id to queue-id mapping profile.";
        leaf name {
          type bbf-yang:string-ascii64;
          description
            "The name of a traffic-class-id to queue-id mapping
profile.";
        }

        list mapping-entry {
          key "traffic-class-id";
          description
            "A traffic-class-id to queue-id mapping profile. One profile
maps each of the traffic-class-ids to a queue-id.";
          leaf traffic-class-id {
            type bbf-qos-t:traffic-class-id;
            description
              "A traffic-class-id.";
          }

          leaf local-queue-id {
            type queue-id;
            mandatory true;
            description
              "The identification of a queue locally within a parent
node context.";
          }
        }  // list mapping-entry
      }  // list tc-id-2-queue-id-mapping-profile

      list bac-entry {
        key "name";
        description
          "A Buffer Acceptance Control (BAC) entry.";
        leaf name {
          type bbf-yang:string-ascii64;
          description
            "The name of a BAC entry.";
        }

        leaf max-queue-size {
          type uint32;
          units "bytes";
          description
            "The maximum queue length.";
        }

        choice bac-type {
          mandatory true;
          description "Choice of BAC types.";
          case taildrop {
            description
              "Applicable when the BAC type is 'taildrop'.";
            container taildrop {
              description
                "Management data nodes associated with taildrop.";
              leaf max-threshold {
                type bbf-yang:percent;
                description
                  "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
              }
            }  // container taildrop
          }  // case taildrop

          case red {
            description
              "Applicable when the BAC type is 'red'.";
            container red {
              description
                "Management data nodes associated with Random Early
Detection (RED).";
              leaf min-threshold {
                type bbf-yang:percent;
                description
                  "The threshold from which the system begins to discard
incoming frames in a random way.

The value is a percentage to be calculated on the value of
the leaf max-queue-size of the queue on which the BAC is
applied.";
              }

              leaf max-threshold {
                type bbf-yang:percent;
                description
                  "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
              }

              leaf max-probability {
                type bbf-yang:percent;
                description
                  "The maximum discard probability of frames before the
maximum threshold is reached.";
              }
            }  // container red
          }  // case red

          case wtaildrop {
            description
              "Applicable when the BAC type is 'wtaildrop'.";
            container wtaildrop {
              description
                "Management data nodes associated with weighted
taildrop.";
              container color {
                description
                  "Management data nodes associated with the marked
color of the frame.";
                container green {
                  description
                    "Green frames.";
                  leaf max-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
                  }
                }  // container green

                container yellow {
                  description
                    "Yellow frames.";
                  leaf max-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
                  }
                }  // container yellow

                container red {
                  description "Red frames.";
                  leaf max-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
                  }
                }  // container red
              }  // container color
            }  // container wtaildrop
          }  // case wtaildrop

          case wred {
            description
              "Applicable when the BAC type is 'wred'.";
            container wred {
              description
                "Management data nodes associated with Weighted
Random Early Detection.";
              container color {
                description
                  "Management data nodes associated with the marked
color of the frame.";
                container green {
                  description
                    "Green frames.";
                  leaf min-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold from which the system begins to discard
incoming frames in a random way.

The value is a percentage to be calculated on the value of
the leaf max-queue-size of the queue on which the BAC is
applied.";
                  }

                  leaf max-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
                  }

                  leaf max-probability {
                    type bbf-yang:percent;
                    description
                      "The maximum discard probability of frames before the
maximum threshold is reached.";
                  }
                }  // container green

                container yellow {
                  description
                    "Yellow frames.";
                  leaf min-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold from which the system begins to discard
incoming frames in a random way.

The value is a percentage to be calculated on the value of
the leaf max-queue-size of the queue on which the BAC is
applied.";
                  }

                  leaf max-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
                  }

                  leaf max-probability {
                    type bbf-yang:percent;
                    description
                      "The maximum discard probability of frames before the
maximum threshold is reached.";
                  }
                }  // container yellow

                container red {
                  description "Red frames.";
                  leaf min-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold from which the system begins to discard
incoming frames in a random way.

The value is a percentage to be calculated on the value of
the leaf max-queue-size of the queue on which the BAC is
applied.";
                  }

                  leaf max-threshold {
                    type bbf-yang:percent;
                    description
                      "The threshold to discard all incoming frames.

The value is a percentage to be calculated on the value of
the leaf max-queue-size.";
                  }

                  leaf max-probability {
                    type bbf-yang:percent;
                    description
                      "The maximum discard probability of frames before the
maximum threshold is reached.";
                  }
                }  // container red
              }  // container color
            }  // container wred
          }  // case wred
        }  // choice bac-type
      }  // list bac-entry

      list shaper-profile {
        key "name";
        description "A shaper profile.";
        leaf name {
          type bbf-yang:string-ascii64;
          description
            "The name of a shaper profile.";
        }

        choice shaper-type {
          mandatory true;
          description
            "Choice of shaper types.";
          case single-token-bucket {
            description
              "Applicable when the shaper type is single token.";
            container single-token-bucket {
              description
                "A shaper which shapes traffic up to a Peak Information
Rate (PIR).";
              leaf pir {
                type uint32;
                units "kbits per second";
                description
                  "The Peak Information Rate (PIR), in kilobits per
second.";
              }

              leaf pbs {
                type uint32;
                units "bytes";
                description
                  "The Peak Burst Size (PBS), in bytes.";
              }
            }  // container single-token-bucket
          }  // case single-token-bucket

          case two-token-bucket {
            if-feature two-token-bucket-shaper;
            container two-token-bucket {
              description
                "A shaper which shapes traffic up to a Peak Information
Rate (PIR) which also enforces a separate traffic rate
limit as specified by a Committed Information Rate
(CIR).

The rate of traffic which exceeds CIR but is less than
or equal to PIR, is considered to be the Excess
Information Rate (EIR) traffic.";
              leaf pir {
                type uint32;
                units "kbits per second";
                mandatory true;
                description
                  "The Peak Information Rate (PIR), in kilobits per
second.";
              }

              leaf cir {
                type uint32;
                units "kbits per second";
                mandatory true;
                description
                  "The Committed Information Rate (CIR), in kilobits per
second.";
              }
            }  // container two-token-bucket
          }  // case two-token-bucket
        }  // choice shaper-type
      }  // list shaper-profile
    }  // container tm-profiles
  }  // module bbf-qos-traffic-mngt