submodule bbf-vdsl-virtual-noise-profile-body {

    yang-version 1.1;

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

    include bbf-vdsl-base-body;

    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 5.7 DSL Quality Management
     related profiles; Virtual Noise 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 vn-descriptor {
      description
        "Specifies the format of the Virtual Noise (VN) PSD.";
      list psdmask {
        key "sub-carrier";
        description
          "The virtual noise Power Spectral Density (PSD) level.";
        leaf sub-carrier {
          type sub-carrier-index;
          description "Sub-carrier index.";
        }

        leaf psd-level {
          type union {
            type uint8 {
              range "0..200";
            }
            type enumeration {
              enum "zero-watts-per-hz" {
                value 0;
                description
                  "Indicates a noise level of 0 Watts per Hz (minus
                 infinity dBm per Hz).";
              }
            }
          }
          units "-0.5 dBm per Hz";
          mandatory true;
          description
            "The noise level, ranges from -40 dBm per Hz to -140 dBm per
           Hz in steps of -0.5 dBm per Hz, with an offset of -40 dBm
           per Hz. The virtual noise level = -psd-level/2 -40 dBm per
           Hz. A special value of (enum zero-watts-per-hz) indicates
           a noise level of 0 Watts per Hz (minus infinity dBm per
           Hz). The default is an empty list, corresponding to no
           virtual noise defined.";
        }
      }  // list psdmask
    }  // grouping vn-descriptor

    grouping virtual-noise-profile {
      description
        "Configuration parameters for downstream Virtual Noise (VN).";
      container virtual-noise {
        must 'count(psdmask) != 1' {
          error-message
            "Only one 'psdmask' is defined.";
          description
            "There must be either 0 or 2 to 32 Power Spectral Density
           (PSD) mask breakpoints defined.";
        }
        description
          "This configuration parameter VN defines the transmitter
         referred virtual noise (TXREFVN). The TXREFVN is specified
         through a set of breakpoints. Each breakpoint consists of a
         subcarrier index t, with a subcarrier spacing of 4.3125 kHz,
         and a noise Power Spectral Density (PSD) level (expressed in
         dBm per Hz) at that subcarrier. The set of breakpoints can
         then be represented as [(t1, PSD1), (t2, PSD2), (tN, PSDN)].
         The subcarrier index is coded as an unsigned integer. The
         noise level ranges from -40 dBm per Hz to -140 dBm per Hz in
         steps of 0.5 dBm per Hz. A special value of (enum
         zero-watts-per-hz) indicates a noise level of 0 Watts per Hz.
         The maximum number of breakpoints is 32. The default is an
         empty list, corresponding to no virtual noise defined.";
        reference
          "ITU-T G.997.1 clause 7.3.1.7.3 (VNds)";

        uses vn-descriptor {
          refine 
        }
      }  // container virtual-noise

      container fext-txrefvnds {
        description
          "For ITU-T G.992.3 (ADSL2) Annex C and ITU-T G.992.5
         (ADSL2plus) Annex C, the transmitter referred virtual noise
         (see clause 7.3.1.7.3) specified for FEXTR duration is
         defined as Far-End Crosstalk (FEXT) downstream transmitter
         referred virtual noise (FEXT TXREFVNds). The default is an
         empty list, corresponding to no virtual noise defined.";
        reference
          "ITU-T G.997.1 clause 7.3.1.7.3.1 (FEXT TXREFVNds)";

        uses vn-descriptor;
      }  // container fext-txrefvnds

      container next-txrefvnds {
        description
          "For ITU-T G.992.3 (ADSL2) Annex C and ITU-T G.992.5
         (ADSL2plus) Annex C, the transmitter referred virtual noise
         specified for NEXTR duration is defined as Near-End Crosstalk
         (NEXT) downstream transmitter referred virtual noise (NEXT
         TXREFVNds). The default is an empty list, corresponding to no
         virtual noise defined.";
        reference
          "ITU-T G.997.1 clauses 7.3.1.7.3 and 7.3.1.7.3.2
          (NEXT TXREFVNds)";

        uses vn-descriptor;
      }  // container next-txrefvnds

      leaf txrefvnsfds {
        type int8 {
          range "-128..127";
        }
        units "0.5 dB";
        default "0";
        description
          "If SNRM_MODE = 4, this configuration parameter defines the
         downstream transmitter referred virtual noise scaling factor.
         The valid values for the transmitter referred virtual noise
         scaling factor range from -64.0 dB to 63.5 dB, in steps of
         0.5 dB. The default is an empty list, corresponding to no
         virtual noise defined.";
        reference
          "ITU-T G.997.1 clause 7.3.1.7.6 (TXREFVNSFds)";

      }
    }  // grouping virtual-noise-profile

    grouping virtual-noise-profile-upstream {
      description
        "Configuration parameters for upstream Virtual Noise (VN).";
      container virtual-noise {
        must 'count(psdmask) != 1' {
          error-message
            "Only one 'psdmask' is defined.";
          description
            "There must be either 0 or 2 to 16 Power Spectral Density
           (PSD) mask breakpoints defined.";
        }
        description
          "This configuration parameter Virtual Noise (VN) defines the
         transmitter referred virtual noise (TXREFVN). The TXREFVN is
         specified through a set of breakpoints. Each breakpoint
         consists of a subcarrier index t, with a subcarrier spacing
         of 4.3125 kHz, and a noise Power Spectral Density (PSD) level
         (expressed in dBm per Hz) at that subcarrier. The set of
         breakpoints can then be represented as [(t1, PSD1),
         (t2, PSD2), (tN, PSDN)]. The subcarrier index is coded as an
         unsigned integer. The noise level ranges from -40 dBm per Hz
         to -140 dBm per Hz in steps of 0.5 dBm per Hz. A special
         value of (enum zero-watts-per-hz) indicates a noise level of
         0 Watts per Hz. The maximum number of breakpoints is 16.
         The default is an empty list, corresponding to no virtual
         noise defined.";
        reference
          "ITU-T G.997.1 clause 7.3.1.7.4 (VNus)";

        uses vn-descriptor {
          refine 
        }
      }  // container virtual-noise

      leaf rxrefvnsfus {
        type int8 {
          range "-128..127";
        }
        units "0.5 dB";
        default "0";
        description
          "If SNRM_MODE = 4, this configuration parameter defines the
         receiver-referred virtual noise scaling factor. The valid
         values for the receiver-referred virtual noise scaling factor
         range from -64.0 dB to 63.5 dB, in steps of 0.5 dB. The
         default is an empty list, corresponding to no virtual noise
         defined.";
        reference
          "ITU-T G.997.1 clause 7.3.1.7.5 (RXREFVNSFus)";

      }
    }  // grouping virtual-noise-profile-upstream
  }  // submodule bbf-vdsl-virtual-noise-profile-body