submodule bbf-vdsl-data-rate-profile-body {

    yang-version 1.1;

    belongs-to bbf-vdsl {
        prefix bbf-vdsl;
    }

    import bbf-yang-types {
      prefix bbf-yang;
    }

    include bbf-vdsl-base;

    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:      Ken Kerpez, ASSIA, Inc.

Editor:      Joey Boyd, Adtran

PS Leader:   Joey Boyd, Adtran

WA Director: Sven Ooghe, Nokia

WA Director: Joey Boyd, Adtran";

    description
      "This submodule contains a collection of YANG definitions for
managing Broadband Forum TR-252i3 clause 5.5 Service related
profiles; dowstream Data Rate Profile and upstream Data Rate
Profile.

Copyright (c) 2016-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-355a4; see
the TR itself for full legal notices.";

    revision "2022-05-23" {
      description
        "Amendment 4.
* Approval Date:    2022-05-23
* Publication Date: 2022-05-23.";
      reference
        "TR-355a4: YANG Modules for FTTdp Management
        	    <https://www.broadband-forum.org/download/
        		   TR-355_Amendment-4.pdf>";

    }

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

    }

    revision "2019-10-21" {
      description
        "Amendment 2 Corrigendum 1.
* Approval Date:    2019-10-21
* Publication Date: 2019-10-21.";
      reference
        "TR-355a2c1: YANG Modules for FTTdp Management
        	    <https://www.broadband-forum.org/download/
        		   TR-355_Amendment-2.pdf>";

    }

    revision "2019-06-11" {
      description
        "Amendment 2.
* Approval Date:    2019-06-11
* Publication Date: 2019-06-11.";
      reference
        "TR-355a2: YANG Modules for FTTdp Management
        	  <https://www.broadband-forum.org/technical/download/
        		 TR-355_Amendment-2.pdf>";

    }

    revision "2018-10-01" {
      description
        "Amendment 1.
* Approval Date:    2018-10-01
* Publication Date: 2018-10-01.";
      reference
        "TR-355a1: YANG Modules for FTTdp Management
        	  <https://www.broadband-forum.org/technical/download/
        		 TR-355_Amendment-1.pdf>";

    }

    revision "2017-11-27" {
      description
        "Corrigendum 2 (fixes to the previous revision).
* Approval Date:    see revision date above.
* Publication Date: 2018-01-19.";
      reference
        "TR-355c2: YANG Modules for FTTdp Management
        	  <https://www.broadband-forum.org/technical/download/
        		 TR-355_Corrigendum-2.pdf>";

    }

    revision "2017-03-13" {
      description
        "Corrigendum 1 (fixes to the initial revision).
* Approval Date:    see revision date above.
* Publication Date: 2017-04-12.";
      reference
        "TR-355c1: YANG Modules for FTTdp Management
        	  <https://www.broadband-forum.org/technical/download/
        		 TR-355_Corrigendum-1.pdf>";

    }

    revision "2016-07-18" {
      description
        "Initial revision.
* Approval Date:    see revision date above.
* Publication Date: 2016-08-05.";
      reference
        "TR-355: YANG Modules for FTTdp Management
        	<https://www.broadband-forum.org/technical/download/
        		 TR-355.pdf>";

    }


    grouping data-rate-profile {
      description
        "Data rate profile for upstream and downstream.";
      leaf minimum-net-data-rate {
        type bbf-yang:data-rate32;
        must ". <= ../maximum-net-data-rate" {
          error-message
            "'minimum-net-data-rate' is greater than 'maximum-net-data-rate'.";
          description
            "The minimum net data rate must be less than or equal the
maximum net data rate.";
        }
        default "0";
        description
          "If retransmission is not used in a given transmit direction,
this parameter specifies the minimum net data rate for the
bearer channel as desired by the operator of the system. The
data rate is coded in steps of 1000 bits per second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.1";

      }

      leaf maximum-net-data-rate {
        type bbf-yang:data-rate32;
        default "4294967295";
        description
          "If retransmission is not used in a given transmit direction,
this parameter specifies the maximum net data rate for the
bearer channel as desired by the operator of the system. The
data rate is coded in steps of 1000 bits bit per second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.3";

      }

      leaf minimum-data-rate-in-low-power-state {
        type bbf-yang:data-rate32;
        default "0";
        description
          "This parameter specifies the minimum net data rate for the
bearer channel as desired by the operator of the system
during the low power state (L1/L2). The power management low
power states L1 and L2 are defined in ITU-T G.992.2 and
ITU-T G.992.3, respectively. The data rate is coded in
steps of 1000 bits per second. This parameter is only
applicable to the downstream direction in case of operation
according to G.992.2, G.992.3, G.992.4 or G.992.5. If not
applicable, its value is ignored until its use is defined.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.5;
          ITU-T G.992.2;
          ITU-T G.992.3";

      }

      leaf maximum-bit-error-ratio {
        type enumeration {
          enum "1e-3" {
            value 0;
            description
              "Bit error ratio 1e-3.";
          }
          enum "1e-5" {
            value 1;
            description
              "Bit error ratio 1e-5.";
          }
          enum "1e-7" {
            value 2;
            description
              "Bit error ratio 1e-7.";
          }
        }
        default "1e-7";
        description
          "If retransmission is not used in a given transmit direction,
this parameter specifies the maximum bit error ratio for the
bearer channel as desired by the operator of the system. The
bit error ratio can take the values 10^-3, 10^-5 or 10^-7.
The default is 1e-7.";
        reference
          "ITU-T G.997.1 clause 7.3.2.6";

      }

      leaf data-rate-threshold-upshift {
        type bbf-yang:data-rate32;
        default "0";
        description
          "If retransmission is not used in a given transmit direction,
this parameter is a threshold on the net data rate upshift
achieved over one or more bearer channel data rate
adaptations. An upshift rate change alarm (event) is
triggered when the actual data rate exceeds the data rate at
the last entry into showtime by more than the threshold. The
data rate threshold is coded in 1000 bits per second. The
default of 0 corresponds to no event on a threshold
crossing.";
        reference
          "ITU-T G.997.1 clause 7.3.2.8.1";

      }

      leaf data-rate-threshold-downshift {
        type bbf-yang:data-rate32;
        default "0";
        description
          "If retransmission is not used in a given transmit direction,
this parameter is a threshold on the net data rate downshift
achieved over one or more bearer channel data rate
adaptations. A downshift rate change alarm (event) is
triggered when the actual data rate is below the data rate at
the last entry into showtime by more than the threshold. The
data rate threshold is coded in 1000 bits per second. The
default of 0 corresponds to no event on a threshold
crossing.";
        reference
          "ITU-T G.997.1 clause 7.3.2.8.2";

      }

      leaf minimum-sos-data-rate {
        type bbf-yang:data-rate32;
        default "0";
        description
          "This parameter specifies the minimum net data rate for the
bearer channel required for a valid Save Our Showtime (SOS)
request in the direction of the bearer channel. The value
will be coded as an unsigned integer representing the data
rate is coded in steps of 1000 bits per second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.6 (MIN-SOS-DR)";

      }

      leaf minimum-expected-throughput-rtx {
        type bbf-yang:data-rate32;
        must
          ". <= ../maximum-expected-throughput-rtx" {
          error-message
            "'minimum-expected-throughput-rtx' is greater than 'maximum-expected-throughput-rtx'.";
          description
            "The minimum expected throughput must be less than or equal
to the maximum expected throughput for retransmission.";
        }
        default "0";
        description
          "If retransmission is used in a given transmit direction,
this parameter specifies the minimum expected throughput
for the bearer channel. The rate is coded in steps of 1000
bits per second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.8 (MINETR_RTX);
          ITU-T G.998.4 clause 11.1.1";

      }

      leaf maximum-expected-throughput-rtx {
        type bbf-yang:data-rate32;
        must
          ". <= ../maximum-net-data-rate-rtx" {
          error-message
            "'maximum-expected-throughput-rtx' is greater than  'maximum-net-data-rate-rtx'.";
          description
            "The maximum expected throughput must be less than or equal
to the maximum net data rate for retransmission.";
        }
        default "4294967295";
        description
          "If retransmission is used in a given transmit direction, this
parameter specifies the maximum expected throughput for the
bearer channel. The rate is coded in steps of 1000 bits per
second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.9 (MAXETR_RTX);
          ITU-T G.998.4 clause 11.1.2";

      }

      leaf maximum-net-data-rate-rtx {
        type bbf-yang:data-rate32;
        default "4294967295";
        description
          "If retransmission is used in a given transmit direction, this
parameter specifies the maximum net data rate for the bearer
channel. The rate is coded in steps of 1000 bits per
second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.1.10 (MAXNDR_RTX);
          ITU-T G.998.4 clause 11.1.3";

      }

      leaf target-net-data-rate {
        type bbf-yang:data-rate32;
        default "4294967295";
        description
          "If retransmission is not used in a given transmit direction,
this parameter specifies the target net data rate of the
bearer channel. The target expected throughput is coded in
steps of 1000 bits per second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.19.1 (TARGET_NDR);
          ITU-T G.993.5";

      }

      leaf target-expected-throughput {
        type bbf-yang:data-rate32;
        default "4294967295";
        description
          "If retransmission is used in a given transmit direction, this
parameter specifies the target expected throughput for the
bearer channel. The target expected throughput is coded in
steps of 1000 bits per second.";
        reference
          "ITU-T G.997.1 clause 7.3.2.19.2 (TARGET_ETR);
          ITU-T G.993.5";

      }

      leaf leftr-defect-threshold {
        if-feature bbf-vdsl:data-rate-profile-leftr;
        type union {
          type uint8 {
            range "0..99";
          }
          type enumeration {
            enum "etr-default-threshold" {
              value 0;
              description
                "Indicates that the Expected Throughput Rate (ETR) shall
be used as the default threshold for declaring a Low
Error-Free Throughput Rate (leftr) defect.";
            }
          }
        }
        units "0.01";
        default "etr-default-threshold";
        description
          "If retransmission is used in a given transmit direction,
LEFTR_THRESH specifies the threshold for declaring a leftr
defect. The value is coded as a fraction of the NDR with
valid range from 0.00 to 0.99 in increments of 0.01. The
value 0.00 implies no leftr-defects are declared. A special
value of (enum etr-default-threshold) means the Expected
Throughput Rate (ETR) shall be used as the default threshold
for declaring a Low Error-Free Throughput Rate (leftr)
defect.";
        reference
          "ITU-T G.997.1 clause 7.3.1.12 (LEFTR_THRESH);
          ITU-T G.998.4 clause 11.1.12";

      }
    }  // grouping data-rate-profile
  }  // submodule bbf-vdsl-data-rate-profile-body