submodule bbf-ghn-link-status-body {

    yang-version 1.1;

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

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

    include bbf-ghn-types;

    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:      Marcos Martinez, Marvell Semiconductor Inc.

     PS Leader:   Joey Boyd, ADTRAN

     PS Leader:   Ken Kerpez, ASSIA

     WA Director: Joey Boyd, ADTRAN

     WA Director: Sven Ooghe, Nokia";

    description
      "This module contains a collection of link status-related
     state data

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

    revision "2018-07-13" {
      description
        "Initial revision.
       * Approval Date:    2018-06-04.
       * Publication Date: see revision date above.";
      reference
        "TR-374: Yang Modules for Management of G.hn Systems in FTTdp
        	Architecture <https://www.broadband-forum.org/technical
        			      /download/TR-374.pdf>";

    }


    grouping link-status-parameters {
      description "Link status parameters.";
      container rates {
        description
          "Status information related to data rates.";
        leaf maximum-bit-rate {
          type bbf-yang:data-rate32-or-undetermined;
          description
            "The maximum physical (PHY) bit rate supported by this link 
           under ideal conditions.";
          reference
            "ITU-T G.9961 Note 1 of Table 8-48";

        }

        leaf out-estimated-phy-rate {
          type bbf-yang:data-rate32-or-undetermined;
          description
            "The estimated Transmission PHY bit rate supported by this 
           link.";
          reference
            "ITU-T G.9961 Note 1 of Table 8-48";

        }

        leaf in-estimated-phy-rate {
          type bbf-yang:data-rate32-or-undetermined;
          description
            "The estimated Transmission PHY bit rate supported by this 
           link.";
          reference
            "ITU-T G.9961 Note 1 of Table 8-48";

        }

        leaf out-phy-rate {
          type bbf-yang:data-rate32-or-undetermined;
          description
            "The actual transmission PHY bit rate for this link.";
          reference
            "ITU-T G.9961 Note 1 of Table 8-48";

        }

        leaf in-phy-rate {
          type bbf-yang:data-rate32-or-undetermined;
          description
            "The actual received PHY bit rate for this link.";
          reference
            "ITU-T G.9961 Note 1 of Table 8-48";

        }
      }  // container rates

      container channel {
        description
          "Status information related to the channel conditions.";
        leaf sub-carrier-grouping {
          type sub-carrier-grouping;
          description
            "Group ID selected for reporting channel 
           estimation information.";
        }

        list port {
          key "port-number";
          description
            "List of channel-related information by port (Physical
           connection to the medium.";
          reference
            "ITU-T G.9963 definition 3.2.8";

          leaf port-number {
            type uint8 {
              range "1..2";
            }
            must
              '(. = 1 and ../../../../../node/status/medium-'
                + 'access-type = "mimo")or(. = 2 and ../../../../../'
                + 'node/status/medium-access-type = "siso")';
            description
              "Port number for the reported channel.";
          }

          leaf tidx-min {
            type tid;
            description
              "Lowest sub-carrier index to which non-zero bits are 
             assigned.";
            reference
              "ITU-T G.9961 clause 8.11";

          }

          leaf tidx-max {
            type tid;
            description
              "Highest sub-carrier index to which non-zero bits are 
             assigned.";
            reference
              "ITU-T G.9961 clause 8.11";

          }

          leaf bpc {
            type bpc;
            description
              "Bit per carrier assigned for a group of carriers
             as described in Table 8-93 of ITU-T G.9961.";
            reference
              "ITU-T G.9961 clause 8.11";

          }
        }  // list port

        container spectrum {
          description
            "Status information related to the spectrum used
           for this link.";
          list sub-carrier-mask {
            key "notch-number";
            description
              "List of sub carrier mask applied to the link.";
            leaf notch-number {
              type number-of-sub-carrier-mask;
              description "Notch number";
            }

            leaf lowest-index {
              type tid;
              description
                "Lowest index for this sub-carrier mask.";
              reference
                "ITU-T G.9964 clause 5.1";

            }

            leaf highest-index {
              type tid;
              description
                "Highest index for this sub-carrier mask.";
              reference
                "ITU-T G.9964 clause 5.1";

            }
          }  // list sub-carrier-mask

          list radio-amateur-mask {
            key "notch-number";
            description
              "List of radio amateur mask applied to the link.";
            leaf notch-number {
              type number-of-radio-amateur-mask;
              description "Notch number";
            }

            leaf lowest-index {
              type tid;
              description
                "Lowest index for this radio-amateur mask.";
              reference
                "ITU-T G.9964 clause 5.3";

            }

            leaf highest-index {
              type tid;
              description
                "Highest index for this radio-amateur mask.";
              reference
                "ITU-T G.9964 clause 5.3";

            }
          }  // list radio-amateur-mask
        }  // container spectrum
      }  // container channel
    }  // grouping link-status-parameters
  }  // submodule bbf-ghn-link-status-body