bbf-fast-vectoring-profile-body

Version: 2022-06-13
bbf-fast-vectoring-profile-body@2022-06-13


  submodule bbf-fast-vectoring-profile-body {

    yang-version 1.1;

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

    include bbf-fast-base;

    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 vectoring profiles.

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-355a4c1; see
the TR itself for full legal notices.";

    revision "2022-06-13" {
      description
        "Amendment 4 Corrigendum 1.
* Approval Date:    2022-06-13
* Publication Date: 2022-06-13.";
      reference
        "TR-355a4c1: YANG Modules for FTTdp Management
        	    <https://www.broadband-forum.org/download/
        		   TR-355_Amendment-4.pdf>";

    }

    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 "2020-01-17" {
      description
        "Amendment 2 Corrigendum 2.
* Approval Date:    2020-01-17
* Publication Date: 2020-01-17.";
      reference
        "TR-355a2c2: YANG Modules for FTTdp Management
        	    <https://www.broadband-forum.org/download/
        		   TR-355_Amendment-2.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 "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 vectoring-parameters {
      description
        "Vectoring configuration parameters applicable to both
upstream and downstream.";
      reference
        "ITU-T G.997.2 clause 7.1.7";

      leaf fext-to-cancel-enable {
        type boolean;
        default "true";
        description
          "Defines whether Far-End Crosstalk (FEXT) cancellation in the
given direction from all the other vectored lines into the
line in the vectored group is enabled or disabled.";
        reference
          "ITU-T G.997.2 clauses 7.1.7.1 (FEXT_TO_CANCEL_ENABLEds) and
          7.1.7.2 (FEXT_TO_CANCEL_ENABLEus);
          ITU-T G.9701 clause 11.4.3.1";

      }

      leaf tgvn-allowed {
        if-feature bbf-fast:tgvn;
        type boolean;
        default "false";
        description
          "Defines whether Targeted Generalized Vectoring with
Non-active G.9701 supporting lines (TGVN) is allowed on the
line.";
        reference
          "ITU-T G.997.2 clause 7.1.7.5 (TGVN_ALLOWED)";

      }
    }  // grouping vectoring-parameters

    grouping vectoring-downstream-parameters {
      description
        "Vectoring configuration parameters applicable in the
downstream direction.";
      reference
        "ITU-T G.997.2 clause 7.1.7";

      leaf xlog-group-size-req {
        type uint8 {
          range
            "1 | 2 | 4 | 8 | 16 | 32 | 64";
        }
        units "sub-carriers";
        default "1";
        description
          "This parameter is the requested lower bound on the value of
XLOGGds in the reporting of Xlogpsds.";
        reference
          "ITU-T G.997.2 clause 7.1.7.3 (XLOGGREQds);
          ITU-T G.9701 clause 11.4.3.2";

      }
    }  // grouping vectoring-downstream-parameters

    grouping vectoring-profile {
      description
        "Defines the contents of a Vectoring Profile.";
      container downstream {
        description
          "Downstream vectoring parameters.";
        uses vectoring-parameters;

        uses vectoring-downstream-parameters;
      }  // container downstream

      container upstream {
        description
          "Upstream vectoring parameters.";
        uses vectoring-parameters;
      }  // container upstream

      leaf annex-x-mode {
        if-feature bbf-fast:annex-x;
        type enumeration {
          enum "forbidden" {
            value 0;
            description
              "AnnexX_FORBIDDEN (Operation according to
Annex X operation is not allowed.).";
          }
          enum "preferred" {
            value 1;
            description
              "AnnexX_PREFERRED (Operation according to
Annex X is preferred.).";
          }
          enum "forced" {
            value 2;
            description
              "AnnexX_FORCED (Operation according to
Annex is forced.).";
          }
        }
        default "forbidden";
        description
          "Determines whether Annex X operation of ITU-T G.9701 is
enabled.

If 'annex-x-mode' is configured to 'preferred' or 'forced',
then 'annex-d-mode', if supported, must be configured to
'forbidden'.";
        reference
          "ITU-T G.997.2 clause T.2.1.1 (ANNEX_X_MODE);
          ITU-T G.9701 clauses X.6.7.1 and T.2.1";

      }

      leaf annex-d-mode {
        if-feature bbf-fast:annex-d;
        type enumeration {
          enum "forbidden" {
            value 0;
            description
              "AnnexD_FORBIDDEN (Operation according to
Annex D operation is not allowed.).";
          }
          enum "preferred" {
            value 1;
            description
              "AnnexD_PREFERRED (Operation according to
Annex D is preferred.).";
          }
          enum "forced" {
            value 2;
            description
              "AnnexD_FORCED (Operation according to
Annex D is forced.).";
          }
        }
        must
          "(not(boolean(../annex-x-mode))) or (../annex-x-mode = 'forbidden' or . = 'forbidden')" {
          error-message
            "Neither 'annex-x-mode' nor 'annex-d-mode' is configured to 'forbidden'.";
          description
            "At least one of Annex X mode or Annex D mode must be
configured to 'forbidden'.";
        }
        default "forbidden";
        description
          "Determines whether Annex D operation of ITU-T G.9701 is
enabled.

If 'annex-d-mode' is configured to 'preferred' or 'forced',
then 'annex-x-mode', if supported, must be configured to
'forbidden'.";
        reference
          "ITU-T G.997.2 clause T.2.1.2 (ANNEX_D_MODE);
          ITU-T G.9701 clauses D.5.7.1 and T.2.1.1";

      }
    }  // grouping vectoring-profile
  }  // submodule bbf-fast-vectoring-profile-body