submodule bbf-vdsl-xtu-sub-carrier-status-body {

    yang-version 1.1;

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

    include bbf-vdsl-base-body;
    include bbf-vdsl-line-spectrum-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:   Sowrirajan Padmanabhan, Nokia

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 9.1 xDSL Transceiver
Unit (xTU) Sub-Carrier Status.

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

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

    }


    typedef per-sub-carrier-group-uint8 {
      type binary {
        length "0..512";
      }
      description
        "A binary type where each octet represents data belonging to
a sub-carrier group. The first octet represents sub-carrier
group 0 and the last represents sub-carrier group 511.";
    }

    typedef per-sub-carrier-group-uint16 {
      type binary {
        length "0..1024";
      }
      description
        "A binary type where each pair of octets represents data
belonging to a sub-carrier group. The first two octets
represents sub-carrier group 0 and the last two represents
sub-carrier group 511. In each pair of octets, the most
significant byte is loaded first.";
    }

    typedef per-sub-carrier-group-int16-tuple {
      type binary {
        length "0..2048";
      }
      description
        "A binary type where a tuple of octet pairs represent data
belonging to a sub-carrier group. The first tuple
represents sub-carrier group 0 and the last tuple represents
sub-carrier group 511. In each pair of octets in the tuple, the
most significant byte is loaded first. The order of the tuple
is determined by the node to which this type is associated.";
    }

    typedef per-sub-carrier-group-uint16-tuple {
      type binary {
        length "0..192";
      }
      description
        "A binary type where a tuple of octet pairs represent data
belonging to a sub-carrier group. The first tuple
represents sub-carrier group 0 and the last tuple represents
sub-carrier group 511. In each pair of octets in the tuple, the
most significant byte is loaded first. The order of the tuple
is determined by the node to which this type is associated.";
    }

    typedef per-sub-carrier-nibble {
      type binary {
        length "4096";
      }
      description
        "A binary type where each nibble represents data belonging to
a sub-carrier. The first nibble represents sub-carrier 0 and
the last represents sub-carrier 8191.";
    }

    typedef per-sub-carrier-uint16 {
      type binary {
        length "16384";
      }
      description
        "A binary type where each pair of octets represents data
belonging to a sub-carrier. The first two octets represent
sub-carrier 0 and the last two represent sub-carrier 8191.
In each pair of octets, the most significant byte is loaded
first.";
    }

    typedef sub-carrier-group-size {
      type uint8 {
        range "1 | 2 | 4 | 8 | 16";
      }
      description
        "This parameter is the number of subcarriers per group.
The valid values are 1, 2, 4, 8 and 16. For ADSL, this
parameter is equal to 1 and, for VDSL2, it is equal to the size
of a subcarrier group used to compute these parameters.";
      reference
        "ITU-T G.993.2 clause 11.4.1";

    }
  }  // submodule bbf-vdsl-xtu-sub-carrier-status-body