submodule bbf-vdsl-inventory-body {

    yang-version 1.1;

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

    include bbf-vdsl-base;
    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 clause 5.3 xDSL Transceiver
Unit (xTU).

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 "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 inventory {
      description
        "The xDSL Transceiver Unit (xTU) parameters represent an xDSL
transceiver at either end of the xDSL Line. This has two
instantiations: an xDSL Transceiver Unit - Central office
(xTU-C), and an xDSL Transceiver Unit - Remote side (xTU-R).";
      leaf g.994.1-vendor-id {
        type binary {
          length "8";
        }
        description
          "The xDSL Transceiver Unit - Central office (xTU-C) G.994.1
vendor ID is the vendor ID as inserted by the xTU-C in the
G.994.1 CL message. It consists of 8 binary octets, including
a country code followed by a (regionally allocated) provider
code, as defined in [ITU-T T.35]:
 - T.35 country code (2 octets)
 - T.35 provider code (vendor identification) (4 octets)
 - T.35 provider oriented code (vendor revision number) (2
   octets)
The G.994.1 vendor ID should typically identify the vendor of
the xTU-C G.994.1 functionality, whether implemented in
hardware or software. It is not intended to indicate the
system integrator.";
        reference
          "ITU-T G.997.1 clauses 7.4.1 and 7.4.2;
          ITU-T G.994.1";

      }

      leaf system-vendor-id {
        type binary {
          length "8";
        }
        description
          "The xDSL Transceiver Unit system vendor ID is the vendor ID
as inserted by the xDSL Transceiver Unit - Central office
(xTU-C) in the overhead messages or by the by the xDSL
Transceiver Unit - Remote side (xTU-R) in the embedded
operations channel. It consists of 8 binary octets, with same
format as the xTU-C G.994.1 vendor ID
(xtu-g.994.1-vendor-id).";
        reference
          "ITU-T G.997.1 clauses 7.4.3 and 7.4.4;
          ITU-T G.994.1";

      }

      leaf version-number {
        type binary {
          length "0..16";
        }
        description
          "The xDSL Transceiver Unit version number is the version
number as inserted by the xDSL Transceiver Unit - Central
office (xTU-C) in the overhead messages, or by the xDSL
Transceiver Unit - Remote side (xTU-R) in the embedded
operations channel. It is for version control and is vendor
specific information. For the XTU-C, this consists of up to
16 binary octets. For the XTU-R, this consists of up to 16
ASCII characters. It contains the xTU-R firmware version and
the xTU-R model. Both are encoded in this order and
separated by a space character, i.e., <xTU-R firmware
version> <xTU-R model>.";
        reference
          "ITU-T G.997.1 clauses 7.4.5 and 7.4.6";

      }

      leaf serial-number {
        type binary {
          length "0..32";
        }
        description
          "The xDSL Transceiver Unit serial number is the serial number
as inserted by the xDSL Transceiver Unit - Central office
(xTU-C) in the overhead messages, or by the xDSL Transceiver
Unit - Remote side (xTU-R) in the embedded operations
channel. It is vendor specific information. For the XTU-C,
this consists of up to 32 ASCII characters. For this XTU-R,
this contains the equipment serial number, the equipment
model and the equipment firmware version. All are encoded in
this order and separated by space characters, i.e.,
<equipment serial number> <equipment model> <equipment
firmware version>.";
        reference
          "ITU-T G.997.1 clauses 7.4.7 and 7.4.8";

      }

      leaf self-test-result {
        type uint32;
        description
          "This parameter defines the xDSL Transceiver Unit self-test
result. It is coded as a 32-bit integer. The most significant
octet of the self-test result is 00hex if the self-test
passed and 01hex if the self-test failed. The interpretation
of the other octets is vendor discretionary and can be
interpreted in combination with G.994.1 and system vendor
IDs.";
        reference
          "ITU-T G.997.1 clauses 7.4.9 and 7.4.10;
          ITU-T G.994.1";

      }

      leaf-list transmission-system-capabilities {
        type xts-descriptor;
        description
          "This parameter defines the xDSL Transceiver Unit capability
list of the different transmission system types. It is coded
in a bit-map representation with the bits defined in the
reference. This parameter may be derived from the handshaking
procedures defined in ITU-T G.994.1.";
        reference
          "ITU-T G.997.1 clauses 7.3.1.1.1, 7.4.11 and 7.4.12;
          ITU-T G.994.1";

      }

      leaf vdsl2-lr-support {
        if-feature bbf-vdsl:vdsl2-lr;
        type boolean;
        description
          "This parameter indicates the support of VDSL2 Long Reach
(VDSL2-LR) mode. The parameter is set to 'false' if VDSL2-LR
mode is not supported and set to 'true' if VDSL2-LR mode is
supported.";
        reference
          "ITU-T G.997.1 clause 7.4.14 (VDSL2-LR_SUPPORT_O/R)";

      }

      leaf strongfext-support {
        if-feature bbf-vdsl:strongfext;
        type boolean;
        description
          "This parameter indicates the support of operation
according to ITU-T G.993.5 Annex A.
The parameter is set to 'false' if Strong Far-End Crosstalk
(STRONGFEXT) mode is not supported and set to 'true' if
STRONGFEXT mode is supported.";
        reference
          "ITU-T G.997.1 clause 7.4.15 (STRONGFEXT_MODE_SUPPORT_O/R);
          ITU-T G.993.5 Annex A";

      }
    }  // grouping inventory

    grouping vce {
      description
        "Parameters for Vectoring Control Entity (VCE) identity.";
      leaf vce-id {
        type union {
          type uint8 {
            range "1..255";
          }
          type enumeration {
            enum "not-in-vectored-group" {
              value 0;
              description
                "Indicates that the line is not in a vectored group.";
            }
          }
        }
        description
          "For the line in a vectored group, the Vectoring Control
Entity (VCE) ID uniquely identifies the VCE that manages and
controls the vectored group to which the line belongs. It
consists of one octet and valid ranges are from 1 to 255. A
special value (enum not-in-vectored-group) means the line is
not in a vectored group.";
        reference
          "ITU-T G.997.1 clause 7.4.13.1 (VCE_ID)";

      }

      leaf vce-port-index {
        type uint16;
        description
          "For the line in a vectored group, the Vectoring Control
Entity (VCE) port index is the physical index that uniquely
identifies the VCE port to which the line is connected. It is
an integer from 1 to the maximum number of lines supported by
the VCE. The value 0 indicates the line is not in a vectored
group.";
        reference
          "ITU-T G.997.1 clause 7.4.13.2 (VCE_port_index)";

      }
    }  // grouping vce
  }  // submodule bbf-vdsl-inventory-body