module bbf-ghs {

    yang-version 1.1;

    namespace "urn:bbf:yang:bbf-ghs";

    prefix bbf-ghs;

    include bbf-ghs-base;
    include bbf-ghs-pointers;
    include bbf-ghs-handshake-profiles;
    include bbf-ghs-handshake-profile-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 module contains a collection of YANG definitions for
     supporting the Broadband Forum requirements on management of
     handshake as defined in ITU-T G.994.1 clause 14. As such, this
     module is specific to access network equipment (e.g.,
     BBF-specified Access Nodes and FTTdp DPUs).

     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-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 "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>";

    }


    // typedefs
    typedef handshake-profile-ref {
      type leafref {
        path "/bbf-ghs:ghs/bbf-ghs:profiles/bbf-ghs:handshake-profile/bbf-ghs:name";
      }
      description
        "Used to reference a handshake profile.";
    }

    // groupings
    grouping handshake-profile {
      description
        "Defines the parameters contained in a handshake profile.";
      container downstream {
        description
          "Parameters associated with the downstream direction.";
        container sub-carrier-maximum-psd-level {
          description
            "Defines the maximum transmit Power Spectral Density (PSD)
level for each individual G.handshake (G.hs) carrier
frequency index N in the downstream direction. The PSD
level (in dBm/Hz) is calculated as the tone power averaged
over a 4.3125 kHz bandwidth.

The range supported is from -98.5 to -40 dBm/Hz, with 0.5
dB steps. If the value is set to -99 (118), then the
carrier shall not be transmitted.";
          reference
            "ITU-T G.994.1 clause 13";

          list maxpsd {
            key "sub-carrier-index";
            description
              "List of maximum Power Spectral Density (PSD) levels per
carrier with frequency index, N.";
            leaf sub-carrier-index {
              type uint16 {
                range
                  "12|14|40|56|64|72|88|96|257|293|337|383|511|4368|4440|4488";
              }
              description
                "Sub carrier index. For each valid sub-carrier index
not included in this list, the maximum Power Spectral
Density (PSD) level permitted by G.994.1 is allowed.";
            }

            leaf psd-level {
              type uint8 {
                range "0..117 | 118";
              }
              units "-0.5 dBm per Hz";
              must
                "(../sub-carrier-index != 4368 and
 ../sub-carrier-index != 4440 and
 ../sub-carrier-index != 4488) or (. >= 50)" {
                error-message
                  "'psd-level' is less than 50 for 'sub-carrier-index' 4368 and/or 4440 and/or 4488.";
                description
                  "If the sub-carrier-index is 4368, 4440 or 4488, the
Power Spectral Density (PSD) level must be less than
or equal to -65 dBm/Hz corresponding to a 'psd-level'
range of 50 to 117.";
              }
              default "0";
              description
                "Maximum Power Spectral Density (PSD) level.";
            }
          }  // list maxpsd
        }  // container sub-carrier-maximum-psd-level
      }  // container downstream
    }  // grouping handshake-profile

    // objects
    container ghs {
      description
        "G.handshake (G.hs) configuration.";
      container profiles {
        description
          "Configuration profiles.";
      }  // container profiles
    }  // container ghs

    augment /if:interfaces/if:interface/bbf-fastdsl:line {
      description
        "Data nodes for the configuration of G.handshake (G.hs).";
      container ghs {
        presence
          "If present, indicates that the interface is able to operate
according to G.994.1.";
        description
          "Line configuration data for G.handshake (G.hs).";
      }  // container ghs
    }

    augment /bbf-ghs:ghs/bbf-ghs:profiles {
      description
        "Data nodes to support handshake configuration profiles.";
      list handshake-profile {
        key "name";
        description
          "A list of handshake profiles.";
        leaf name {
          type bbf-yang:string-ascii64;
          description
            "A name that uniquely identifies the profile.";
        }

        uses handshake-profile;
      }  // list handshake-profile
    }

    augment /if:interfaces/if:interface/bbf-fastdsl:line/bbf-ghs:ghs {
      description
        "Data nodes to support the assignment of a G.handshake (G.hs)
profile.";
      leaf handshake-profile {
        type handshake-profile-ref;
        description
          "Reference to a G.handshake (G.hs) profile.";
      }
    }
  }  // module bbf-ghs