bbf-fast-line-status-body

This submodule contains a collection of status-related YANG data types and grouping definitions for the management of FAST lines...

  • Version: 2022-05-23

    bbf-fast-line-status-body@2022-05-23


    
      submodule bbf-fast-line-status-body {
    
        yang-version 1.1;
    
        belongs-to bbf-fast {
            prefix bbf-fast;
        }
    
        import bbf-yang-types {
          prefix bbf-yang;
        }
        import ietf-yang-types {
          prefix yang;
        }
    
        include bbf-fast-line-spectrum-profile-body;
        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 status-related YANG
    data types and grouping definitions for the management of
    FAST lines.
    
    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 "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 "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 "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 sub-carrier-group-index {
          type sub-carrier-index;
          description
            "Identifies a sub-carrier group.";
        }
    
        typedef sub-carrier-group-size {
          type uint8 {
            range "1 | 2 | 4 | 8";
          }
          units "sub-carriers";
          description
            "Reports the number of sub-carriers in any one sub-carrier
    group.";
        }
    
        typedef snr-margin {
          type union {
            type bbf-yang:undetermined;
            type int16 {
              range "-511..511";
            }
          }
          units "0.1 dB";
          description
            "Reports the signal-to-noise ratio margin. A first special value
    (undetermined) indicates that the signal-to-noise ratio margin
    is undetermined. A second special value (-511) indicates that
    the signal-to-noise ratio margin is less than or equal to -51.1
    dB. A third special value (+511) indicates that the
    signal-to-noise ratio margin is greater than or equal to
    +51.1 dB.";
        }
    
        typedef vce-port-index {
          type union {
            type enumeration {
              enum "undefined" {
                value 0;
                description
                  "The value of the Vectoring Control Entity (VCE) port
    index is undefined.";
              }
            }
            type uint16 {
              range "1..65535";
            }
          }
          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.";
        }
    
        typedef per-sub-carrier-nibble {
          type binary {
            length "0..2048";
          }
          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 4095.";
        }
    
        typedef per-sub-carrier-uint8 {
          type binary {
            length "0..4096";
          }
          description
            "A binary type where each octet represents data belonging to
    a sub-carrier. The first octet represents sub-carrier 0 and
    the last represents sub-carrier 4095.";
        }
    
        typedef per-sub-carrier-group-uint8 {
          type binary;
          description
            "A binary type where each octet represents data belonging to
    a sub-carrier group. The first octet represents sub-carrier
    group 0.";
        }
    
        typedef per-sub-carrier-group-uint16 {
          type binary;
          description
            "A binary type where each pair of octets represents data
    belonging to a sub-carrier. The first two octets represents
    sub-carrier 0. In each pair of octets, the most significant
    byte is loaded first.";
        }
    
        typedef time-stamp-or-undefined {
          type union {
            type enumeration {
              enum "undefined" {
                value 0;
                description
                  "The value of the time stamp is undefined or unknown.";
              }
            }
            type yang:date-and-time;
          }
          description
            "The date/time associated with a particular time stamp. The
    special value, 'undefined', is used when the event represented
    by the time stamp has not yet occurred.";
        }
    
        grouping line-status-parameters {
          description
            "Line status parameters applicable to both upstream and
    downstream.";
          reference
            "ITU-T G.997.2 clause 7.10";
    
          leaf snr-margin {
            type snr-margin;
            description
              "Reports the signal-to-noise ratio (SNR) margin in the
    applicable direction during the L0 link state. A first
    special value (undetermined) indicates that the
    signal-to-noise ratio margin is undetermined. A second
    special value (-511) indicates that the signal-to-noise ratio
    margin is less than or equal to -51.1 dB. A third special
    value (+511) indicates that the signal-to-noise ratio margin
    is greater than or equal to +51.1 dB.";
            reference
              "ITU-T G.997.2 clauses 7.10.3.1 (SNRMds) and 7.10.3.2
              (SNRMus);
              ITU-T G.9701 clauses 9.8.3.2 and 11.4.1.3.";
    
          }
    
          leaf snr-margin-in-l2.1 {
            type snr-margin;
            description
              "Reports the signal-to-noise ratio (SNR) margin during the
    L2.1N and L2.1B link states. A first special value
    (undetermined) indicates that the signal-to-noise ratio
    margin is undetermined. A second special value (-511)
    indicates that the signal-to-noise ratio margin is less than
    or equal to -51.1 dB. A third special value (+511) indicates
    that the signal-to-noise ratio margin is greater than or
    equal to +51.1 dB.";
            reference
              "ITU-T G.997.2 clauses 7.10.16.1 (L2.1-SNRMds) and 7.10.16.2
              (L2.1-SNRMus);
              ITU-T G.9701 clauses 9.8.3.2 and 11.4.1.1.10.";
    
          }
    
          leaf snr-margin-in-l2.2 {
            type snr-margin;
            description
              "Reports the signal-to-noise ratio (SNR) margin in the
    downstream direction during the L2.2 link state. A first
    special value (undetermined) indicates that the
    signal-to-noise ratio margin is undetermined. A second
    special value (-511) indicates that the signal-to-noise ratio
    margin is less than or equal to -51.1 dB. A third special
    value (+511) indicates that the signal-to-noise ratio margin
    is greater than or equal to +51.1 dB.";
            reference
              "ITU-T G.997.2 clauses 7.10.16.3 (L2.2-SNRMds) and 7.10.16.4
              (L2.2-SNRMus);
              ITU-T G.9701 clauses 9.8.3.2 and 11.4.1.1.10";
    
          }
    
          leaf upbo-electrical-length {
            type uint16 {
              range "0..1280";
            }
            units "0.1 dB";
            description
              "Reports the electrical length that would have been sent, if
    the electrical length was not forced. If the electrical
    length is not forced, then this data node reports the final
    electrical length, as determined by the FAST Transceiver Unit
    (FTU) and conveyed in the O-UPDATE or R-MSG1 initialization
    message accordingly.";
            reference
              "ITU-T G.997.2 clauses 7.10.4.1 (UPBOKLE) and 7.10.4.2
              (UPBOKLE-R);
              ITU-T G.9701 clauses 7.3.1.4.2.1, 9.8.3.2, 11.4.1.3 and
              12.3.3.2.4";
    
          }
    
          leaf actual-aggregate-transmit-power {
            type union {
              type bbf-yang:undetermined;
              type int16 {
                range "-311..311";
              }
            }
            units "0.1 dB";
            description
              "Reports the total amount of transmit power delivered by the
    FAST Transceiver Unit (FTU) at the U reference point, at the
    instant of measurement. A first special value (undetermined)
    indicates that the transmit power is undetermined. A second
    special value (-311) indicates that the transmit power is
    less than or equal to -31.1 dBm. A third special value (+311)
    indicates that the transmit power is greater than or equal to
    +31.1 dBm.";
            reference
              "ITU-T G.997.2 clauses 7.10.5.1 (ACTATPds) and 7.10.5.2
              (ACTATPus);
              ITU-T G.9701 clauses 9.8.3.2 and 11.4.1.5";
    
          }
    
          leaf actual-tx-psd-ps {
            type per-sub-carrier-uint8;
            description
              "Reports the transmit Power Spectral Density (PSD) per
    sub-carrier delivered by the FAST Transceiver Unit (FTU) at
    the U reference point as calculated by the Vector Control
    Entity (VCE) from the appropriate ACTPSDREF-ps.
    
    For each octet, the values 0 to 254 represent the PSD values
    of 0 to -127 dBm/Hz in steps of -0.5 dBm/Hz.
    
    A special value, 255,indicates that no transmit PSD value is
    available the sub-carrier, or its transmit power is zero, or
    is out of the range to be represented.";
            reference
              "ITU-T G.997.2 clauses 7.10.6.1 (ACTPSDpsds) and 7.10.6.2
              (ACTPSDpsus);
              ITU-T G.9701 clause 11.4.1.2.5";
    
          }
    
          container snr {
            description
              "State data nodes related to sub-carrier Signal-to-Noise
    Ratio (SNR) values.";
            leaf snr-psd-measurement-time {
              type uint16;
              units "symbols";
              description
                "Reports the number of symbols used to measure the SNR(f)
    values.";
              reference
                "ITU-T G.997.2 clauses 7.10.8.1 (SNRMTds) and 7.10.8.4
                (SNRMTus);
                ITU-T G.9701 clause 11.4.1.2.2";
    
            }
    
            leaf snr-sub-carrier-group-size {
              type sub-carrier-group-size;
              description
                "Reports the number of sub-carriers in any one sub-carrier
    group used to represent the SNR(f) values.
    
    Note that in ITU-T G.9701-2014 the only valid value is
    G = 1.";
              reference
                "ITU-T G.997.2 clauses 7.10.8.2 (SNRGds) and 7.10.8.5
                (SNRGus);
                ITU-T G.9701 clause 11.4.1.2.2";
    
            }
    
            leaf snrps {
              type per-sub-carrier-group-uint8 {
                length "0..4096";
              }
              description
                "Reports the downstream SNR(f) values.
    
    For each octet, the values 0 to 254 represent the Signal-
    to-Noise Ratio (SNR) values of -32 to 95 dB in steps of
    0.5 dB and an offset of -64 where:
    
      SNR(f) = (snrps - 64) * 0.5
    
    A special value, 255, indicates the cases defined
    in clause 11.4.1.2.2 of [ITU-T G.9701].";
              reference
                "ITU-T G.997.2 clauses 7.10.8.3 (SNRpsds) and 7.10.8.6
                (SNRpsus);
                ITU-T G.9701 clause 11.4.1.2.2";
    
            }
          }  // container snr
    
          leaf bitsps {
            type per-sub-carrier-nibble;
            description
              "Reports the bit allocation values on data symbols in the
    normal operation interval (NOI).
    
    For each nibble, the values 0 to 14 represent the allocated
    bits.";
            reference
              "ITU-T G.997.2 clauses 7.10.11.1 (BITSpsds) and 7.10.11.2
              (BITSpsus);
              ITU-T G.9701 clause 10.2.1.4";
    
          }
    
          container robust-management-channel {
            description
              "Managment data nodes associated with the Robust Management
    Channel (RMC).";
            leaf snr-margin {
              type snr-margin;
              description
                "Reports the signal-to-noise ratio (SNR) margin for the
    Robust Management Channel (RMC) in the applicable direction
    during the L0 link state. A first special value
    (undetermined) indicates that the signal-to-noise ratio
    margin is undetermined. A second special value (-511)
    indicates that the signal-to-noise ratio margin is less
    than or equal to -51.1 dB. A third special value (+511)
    indicates that the signal-to-noise ratio margin is greater
    than or equal to +51.1 dB.";
              reference
                "ITU-T G.997.2 clauses 7.10.12.1 (SNRM-RMCds) and
                7.10.12.2 (SNRM-RMCus);
                ITU-T G.9701 clauses 11.4.1.1.11 and 11.4.1.4";
    
            }
    
            leaf snr-margin-in-l2 {
              type snr-margin;
              description
                "Reports the signal-to-noise ratio (SNR) margin  for the
    Robust Management Channel (RMC) during the L2.1N, L2.1B and
    L2.2 link state. A first special value (undetermined)
    indicates that the signal-to-noise ratio margin is
    undetermined. A second special value (-511) indicates that
    the signal-to-noise ratio margin is less than or equal to
    -51.1 dB. A third special value (+511) indicates that the
    signal-to-noise ratio margin is greater than or equal to
    +51.1 dB.";
              reference
                "ITU-T G.997.2 clauses 7.10.16.5 (L2-SNRM-RMCds) and
                7.10.16.6 (L2-SNRM-RMCus);
                ITU-T G.9701 clauses 11.4.1.1.11 and 11.4.1.4";
    
            }
    
            leaf bitsps {
              type binary {
                length "0..1024";
              }
              description
                "Reports the bit allocation values on data symbols in the
    normal operation interval (NOI).
    
    This is reported via an array of 16-bit values where bits
    15:4 represent the subcarrier index and bits 3:0 represent
    the allocated bits using the values 0 and 2 to 6.
    
    The 16-bit values are loaded into the binary array in
    ascending order of the related sub-carrier-index (lowest
    sub-carrier-index first; highest sub-carrier-index last).";
              reference
                "ITU-T G.997.2 clauses 7.10.12.3 and 7.10.12.4
                (BITSRMCdescriptor:bit-allocation-value).";
    
            }
          }  // container robust-management-channel
    
          leaf signal-attenuation {
            type union {
              type bbf-yang:undetermined;
              type uint16 {
                range "0..1001";
              }
            }
            units "0.1 dB";
            description
              "Reports the signal attention (SATN). A special value
    (undetermined) indicates that the value is undetermined. A
    second special value (0) indicates that the SATN is less than
    or equal to 0 dB. A third special value (1001) indicates that
    the SATN is greater than or equal to 100.1 dB. The data node
    is updated only in L0 link state.";
            reference
              "ITU-T G.997.2 clauses 7.10.15.1 (SATNds) and 7.10.15.2
              (SATNus);
              ITU-T G.9701 clause 11.4.1.7";
    
          }
    
          container qln {
            description
              "State data nodes related to sub-carrier Quiet Line Noise
    (QLN).";
            leaf qln-measurement-time {
              type uint16;
              units "symbols";
              description
                "Reports the number of symbols used to measure the
    downstream QLN(f) values.";
              reference
                "ITU-T G.997.2 clauses 7.10.9.1 (QLNMTds) and 7.10.9.4
                (QLNMTus);
                ITU-T G.9701 clause 11.4.1.2.3";
    
            }
    
            leaf qln-sub-carrier-group-size {
              type sub-carrier-group-size;
              description
                "Reports the number of sub-carriers in any one sub-carrier
    group used to represent the QLN(f) values.";
              reference
                "ITU-T G.997.2 clauses 7.10.9.2 (QLNds) and 7.10.9.5
                (QLNus);
                ITU-T G.9701 clause 11.4.1.2.3";
    
            }
    
            leaf qlnps {
              type per-sub-carrier-group-uint8 {
                length "0..512";
              }
              description
                "Reports the downstream QLN(f) as one value per sub-carrier
    group.
    
    For each octet, the values, 1 to 250 represent the Quiet
    Line Noise (QLN) values of -35.5 to -160 dBm/Hz in steps of
    -0.5 dBm/Hz using an offset of 70 where:
    
      QLN(f) = (qlnps + 70) * -0.5
    
    A first special value (255) indicates that the QLN(f)
    for this sub-carrier group is undetermined.
    
    A second special value (254) indicates that no measurement
    could be done for this sub carrier group because it is out
    of the downstream MEDLEY set.
    
    A third special value (0) indicates that the QLN(f) for
    this sub-carrier group is greater than or equal to
    -35dBm/Hz.
    
    A fourth special value (251) indicates that the
    QLN(f) for this sub-carrier group is less than or equal to
    -160.5 dBm/Hz. The data node is updated only in L0 link
    state.
    
    The value is updated only in L0 link state. For upstream,
    the value is also updated in the O-IDLE-TGVN state.";
              reference
                "ITU-T G.997.2 clauses 7.10.9.3 (QLNpsds) and 7.10.9.6
                (QLNpsus);
                ITU-T G.9701 clause 11.4.1.2.3";
    
            }
          }  // container qln
    
          container hlog {
            description
              "State data nodes related to sub-carrier Hlog.";
            leaf hlog-measurement-time {
              type uint16;
              units "symbols";
              description
                "Reports the number of symbols used to measure Hlog(f)
    values.";
              reference
                "ITU-T G.997.2 clause 7.10.7.1 (HLOGMT); ITU-T
                G.9701 clause 11.4.1.2.1.";
    
            }
    
            leaf hlog-sub-carrier-group-size {
              type sub-carrier-group-size;
              description
                "Reports the number of sub-carriers in any one sub-carrier
    group used to represent the Hlog(f) values.";
              reference
                "ITU-T G.997.2 clause 7.10.7.2 (HLOGG);
                ITU-T G.9701 clause 11.4.1.2.1";
    
            }
    
            leaf hlogps {
              type per-sub-carrier-group-uint16 {
                length "0..1024";
              }
              description
                "Reports the downstream Hlog(f) as one value per sub-carrier
    group.
    
    For each pair of octets, the values, 1 to 1019 represent
    the Hlog values of 5.9 to -95.9 dB of -0.1 dB using an
    offset of -60 where:
    
      Hlog(f) = (hlogps - 60) * -0.1
    
    A first special value (1023) indicates that the Hlog(f) for
    this sub-carrier group is undetermined.
    
    A second special value (1022) indicates that no measurement
    could be done for this sub carrier group because it is out
    of the MEDLEY set.
    
    A third special value (0) indicates that the Hlog(f) for
    this sub-carrier group is greater than or equal to +6.0 dB.
    
    A fourth special value (1020) indicates that the Hlog(f)
    for this sub-carrier group is less than or equal to
    -96.0 dB. The data node is updated only in L0 link state.";
              reference
                "ITU-T G.997.2 clause 7.10.7.3 (HLOGps);
                ITU-T G.9701 clause 11.4.1.2.1";
    
            }
          }  // container hlog
        }  // grouping line-status-parameters
    
        grouping line-ftu-update-test {
          description
            "Update test parameters associated with a Fast Transceiver
    Unit.";
          leaf time-stamp-at-g1-update {
            type time-stamp-or-undefined;
            description
              "Reports the date/time when the test parameters group 1
    that can change during showtime was last updated.";
            reference
              "ITU-T G.997.2 clause 7.10.13.1 (STAMP-TEST-NE-G1) and clause
              7.10.13.2 (STAMP-TEST-FE-G1); ITU-T G.9701 clause 11.1.";
    
          }
    
          leaf time-stamp-at-g2-update {
            type time-stamp-or-undefined;
            description
              "Reports the date/time when the test parameters group 2
    that can change during showtime was last updated.";
            reference
              "ITU-T G.997.2 clauses 7.10.13.3 (STAMP-TEST-NE-G2) and
              7.10.13.4 (STAMP-TEST-FE-G2);
              ITU-T G.9701 clause 11.1";
    
          }
    
          leaf link-state-at-g1-update {
            type enumeration {
              enum "l0-link-state" {
                value 0;
                description "L0 link state.";
              }
              enum "l2.1n-link-state" {
                value 1;
                description "L2.1N link state.";
              }
              enum "l2.1b-link-state" {
                value 2;
                description "L2.1B link state.";
              }
              enum "l2.2-link-state" {
                value 3;
                description "L2.2 link state.";
              }
            }
            description
              "Report the link state during which test parameters in group 1
    were updated.";
            reference
              "ITU-T G.997.2 clauses 7.14.2.2 (LINK-STATE-TEST-NE-G1) and
              7.14.2.3 (LINK-STATE-TEST-FE-G1);
              ITU-T G.9701 clause 12.1.1.7.3";
    
          }
        }  // grouping line-ftu-update-test
    
        grouping line-time-stamps {
          description
            "Time stamps associated with the upstream or downstream
    direction.";
          leaf time-stamp-last-successful-bitswap {
            type time-stamp-or-undefined;
            description
              "Reports the date/time of the last successful Fast Transceiver
    Unit (FTU) initiated Bit Swap execution that has modified the
    bits allocation.";
            reference
              "ITU-T G.997.2 clause 7.10.14.1 (STAMP-BSW-ds) and 7.10.14.2
              (STAMP-BSW-us);
              ITU-T G.9701 clause 11.2.2.5";
    
          }
    
          leaf time-stamp-last-successful-autonomous-sra {
            type time-stamp-or-undefined;
            description
              "Reports the date/time of the last successful Fast Transceiver
    Unit (FTU) initiated autonomous Seamless Rate Adaptation
    (SRA) execution (excluding SRAs in response to Transmitter-
    Initiated Gain Adjustment (TIGA)) that has modified the
    bits allocation.";
            reference
              "ITU-T G.997.2 clauses 7.10.14.3 (STAMP-SRA-ds) and 7.10.14.4
              (STAMP-SRA-us);
              ITU-T G.9701 clause 11.2.2.5";
    
          }
    
          leaf time-stamp-last-successful-fra {
            type time-stamp-or-undefined;
            description
              "Reports the date/time of the last successful Fast Transceiver
    Unit (FTU) initiated Fast Rate Adaptation (FRA) execution
    that has modified the bits allocation.";
            reference
              "ITU-T G.997.2 clauses 7.10.14.5 (STAMP-FRA-ds) and 7.10.14.6
              (STAMP-FRA-us);
              ITU-T G.9701 clause 13.3.1.1";
    
          }
    
          leaf time-stamp-last-successful-rpa {
            type time-stamp-or-undefined;
            description
              "Reports the date/time of the last successful Fast Transceiver
    Unit (FTU) initiated Robust Managmenet Channel (RMC)
    Parameter Adjustmet (RPA) execution that has modified the
    bits allocation for the RMC.";
            reference
              "ITU-T G.997.2 clause 7.10.14.7 (STAMP-RPA-ds) and 7.10.14.8
              (STAMP-RPA-us);
              ITU-T G.9701 clause 11.2.2.5";
    
          }
    
          leaf time-stamp-last-successful-rmcr {
            if-feature bbf-fast:rmcr;
            type time-stamp-or-undefined;
            description
              "Reports the date/time of the last successful Fast Transceiver
    Unit (FTU) initiated Robust Managmenet Channel (RMC) recovery
    (RMCR) execution that has modified RMC tone allocation.";
            reference
              "ITU-T G.997.2 clause 7.10.14.11 (STAMP-RMCRds) and 7.10.14.12
              (STAMP-RMCRus);
              ITU-T G.9701 clause 13.3.1.2";
    
          }
        }  // grouping line-time-stamps
    
        grouping line-ftu-failure-parameters {
          description
            "FAST Transceiver Unit (FTU) failure parameters applicable to
    both upstream and downstream. The Loss of Signal (LOS), Loss of
    RMC Channel (LOR), and Loss of Margin (LOM) failures are
    mutually exclusive and reflect the reason cause of the
    triggered re-initialization. If no LOS, LOR, or LOM failure is
    declared, then the re-initialization is triggered by a
    High_BER event (see clause 12.1.4/G.9701).";
          leaf loss-of-signal {
            type boolean;
            description
              "A Loss of Signal (LOS) failure is declared when a
    re-initialization is triggered by a persistent near-end los
    defect. A LOS failure is cleared immediately at the start of
    showtime in the receiving direction.";
            reference
              "ITU-T G.997.2 clauses 7.4.1.1 (LOS) and 7.4.2.1 (LOS-FE)";
    
          }
    
          leaf loss-of-rmc {
            type boolean;
            description
              "A Loss of RMC Channel (LOR) failure is declared when a
    re-initialization is triggered by a persistent near-end
    lor defect. A LOR failure is cleared immediately at the start
    of showtime in the receiving direction.";
            reference
              "ITU-T G.997.2 clauses 7.4.1.2 (LOR) and 7.4.2.2 (LOR-FE)";
    
          }
    
          leaf loss-of-margin {
            type boolean;
            description
              "A Loss of Margin (LOM) failure is declared when a
    re-initialization is triggered by a persistent near-end lom
    defect. A LOM failure is cleared immediately at the start of
    showtime in the receiving direction.";
            reference
              "ITU-T G.997.2 clauses 7.4.1.3 (LOM) and 7.4.2.3 (LOM-FE)";
    
          }
    
          leaf loss-of-power {
            type boolean;
            description
              "A Loss of Power (LPR) failure is declared after 2.5 +/- 0.5
    seconds of contiguous near-end lpr primitive presence. An LPR
    failure is cleared after 10 +/- 0.5 seconds of no near-end
    lpr primitive presence.";
            reference
              "ITU-T G.997.2 clauses 7.4.1.4 (LPR) and 7.4.2.3 (LPR-FE)";
    
          }
        }  // grouping line-ftu-failure-parameters
    
        grouping aln-parameters {
          description
            "Data nodes related to ALN(f) functionality.";
          container aln {
            description
              "State data nodes related to sub-carrier Active Line Noise
    (ALN).";
            leaf aln-measurement-time {
              type uint16;
              units "symbols";
              description
                "Reports the number of symbols used to measure ALN(f)
    values.";
              reference
                "ITU-T G.997.2 clause 7.10.10.1 (ALNMT);
                ITU-T G.9701 clause 11.4.1.2.4";
    
            }
    
            leaf aln-sub-carrier-group-size {
              type sub-carrier-group-size;
              description
                "Reports the number of sub-carriers in any one sub-carrier
    group used to represent the ALN(f) values.";
              reference
                "ITU-T G.997.2 clause 7.10.10.2 (ALNG);
                ITU-T G.9701 clause 11.4.1.2.4";
    
            }
    
            leaf alnps {
              type per-sub-carrier-group-uint8 {
                length "0..512";
              }
              description
                "Reports the downstream ALN(f) as one value per sub-carrier
    group.
    
    For each octet, the values, 1 to 250 represent the Active
    Line Noise (ALN) values of -35.5 to -160 dBm/Hz in steps of
    -0.5 dBm/Hz using an offset of 70 where:
    
      ALN(f) = (alnps + 70) * -0.5
    
    A first special value (255) indicates that the ALN(f)
    for this sub-carrier group is undetermined.
    
    A second special value (254) indicates that no measurement
    could be done for this sub carrier group because it is out
    of the downstream MEDLEY set.
    
    A third special value (0) indicates that the ALN(f) for
    this sub-carrier group is greater than or equal to
    -35 dBm/Hz.
    
    A fourth special value (251) indicates that the
    ALN(f) for this sub-carrier group is less than or equal to
    -160.5 dBm/Hz. The data node is updated only in L0 link
    state.";
              reference
                "ITU-T G.997.2 clause 7.10.10.3 (ALNps);
                ITU-T G.9701 clause 11.4.1.2.4";
    
            }
          }  // container aln
        }  // grouping aln-parameters
    
        grouping xlog-parameters {
          description
            "Data nodes related to XLOG functionality.";
          container xlog {
            description
              "State data nodes related to sub-carrier XLOG.";
            container xlogdisturber {
              description
                "Provides information regarding the XLOG disturber to which
    the XLOG values belong.";
              leaf vce-port-index {
                type union {
                  type enumeration {
                    enum "invalid" {
                      value 0;
                      description
                        "The XLOG disturber Vector Control Entity (VCE) port
    index is invalid.";
                    }
                  }
                  type vce-port-index;
                }
                description
                  "The xlogps values are returned for the disturber line
    with this vce-port-index in the same vectored group. A
    special value (invalid) indicates an invalid
    xlog-disturber-vce-port-index.";
                reference
                  "ITU-T G.997.2 clause 7.13.2.6;
                  ITU-T G.9701 clause 11.4.5.1.2";
    
              }
            }  // container xlogdisturber
    
            container xlogbands {
              description
                "Defines the set of sub-carriers for which XLOGpsds is
    reported. For each band in which XLOGpsds is reported,
    XLOGBANDSds contains a triplet of (start_subcarrier_index,
    stop_subcarrier_index, group size). The XLOGpsds is
    reported for all sub-carriers in the band (start and stop
    subcarrier inclusive) with index equal to
    start_subcarrier_index+m*group_size, with m integer. The
    data node is updated only in L0 link state.";
              reference
                "ITU-T G.997.2 clause 7.10.17.1 (XLOGBANDSds);
                ITU-T G.9701 clause 11.4.1.2.8";
    
              list xlog {
                key "band-index";
                max-elements 8;
                description
                  "List of XLOG band edges.";
                leaf band-index {
                  type uint8 {
                    range "1..8";
                  }
                  description "Band index.";
                }
    
                uses sub-carrier-range {
                  refine 
                }
    
                leaf group-size {
                  type uint8 {
                    range
                      "1 | 2 | 4 | 8 | 16 | 32 | 64";
                  }
                  description
                    "The sub-carrier group size.";
                }
              }  // list xlog
            }  // container xlogbands
    
            leaf xlogps {
              type per-sub-carrier-group-uint8 {
                length "0..512";
              }
              description
                "Reports the downstream Xlog(f) as one value per sub-carrier
    group.
    
    For each octet, the values, 1 to 250 represent the Xlog
    values of +39.5 to -85 dB in steps of -0.5 dB
    using an offset of 80 where:
    
      Xlog(f) = (xlogps - 80) * -0.5
    
    A first special value (255) indicates that the Xlog(f) for
    this sub-carrier group is undetermined.
    
    A second special value (254) indicates that no measurement
    could be done for this sub-carrier group.
    
    A third special value (0) indicates that the Xlog(f) for
    this sub-carrier group is greater than or equal to +40.0
    dB.
    
    A fourth special value (251) indicates that the Xlog(f) for
    this sub-carrier group is less than or equal to -85.5 dB.
    The data node is updated only in L0 link state.";
              reference
                "ITU-T G.997.2 clause 7.10.17.2 (XLOGpsds);
                ITU-T G.9701 clause 11.4.1.2.8";
    
            }
          }  // container xlog
        }  // grouping xlog-parameters
    
        grouping line-status {
          description
            "Defines the parameters that define the operational status of
    a FAST line.";
          leaf profile {
            type profiles;
            description
              "Reports for each profile whether operation according to
    that profile is enabled or disabled. Only one profile can be
    enabled.";
            reference
              "ITU-T G.997.2 clause 7.10.1.1 (PROFILE);
              ITU-T G.9701 clause 6";
    
          }
    
          leaf link-state {
            type enumeration {
              enum "l0-link-state" {
                value 0;
                description "L0 link state.";
              }
              enum "l2.1n-link-state" {
                value 1;
                description "L2.1N link state.";
              }
              enum "l2.1b-link-state" {
                value 2;
                description "L2.1B link state.";
              }
              enum "l2.2-link-state" {
                value 3;
                description "L2.2 link state.";
              }
              enum "l3-link-state" {
                value 4;
                description "L3 link state.";
              }
            }
            description
              "Reports the actual link state.";
            reference
              "ITU-T G.997.2 clause 7.14.2.1 (LINK_STATE);
              ITU-T G.9701 clause 12.1.1.6";
    
          }
    
          leaf initialization-success-failure-cause {
            type enumeration {
              enum "successful" {
                value 0;
                description "Successful.";
              }
              enum "config-error" {
                value 1;
                description
                  "Configuration error. This error occurs if the line
    cannot reach the L0 state due to a mismatch of
    configuration and FAST Transceiver Unit (FTU)
    capabilities.";
              }
              enum "config-not-feasible" {
                value 2;
                description
                  "Configuration not feasible on the line. This error
    occurs if the line cannot reach the L0 state due to a
    mismatch of configuration and line and noise
    characteristics.";
              }
              enum "communication-problem" {
                value 3;
                description
                  "Communication problem. This error occurs, for example,
    due to corrupted messages or bad syntax messages or if
    no common mode can be selected in the ITU-T G.994.1
    handshaking procedure or due to a timeout.";
              }
              enum "no-far-end-ftu-detected" {
                value 4;
                description
                  "No far-end FAST Transceiver Unit (FTU) detected. This
    error occurs if the far-end FTU is not powered or not
    connected or if the line is too long to allow detection
    of a far-end FTU.";
              }
              enum "unknown" {
                value 5;
                description
                  "Any other or unknown initialization failure cause.";
              }
            }
            description
              "Reports whether the last full or short initialization
    procedure was successful. If the last initialization
    procedure was not successful, this parameter provides
    the reason.";
            reference
              "ITU-T G.997.2 clause 7.10.2.1 (INITFSCAUSE);
              ITU-T G.9701 clause 12.3.1";
    
          }
    
          leaf annex-x-enabled {
            if-feature bbf-fast:annex-x;
            type boolean;
            description
              "Indicates whether Annex X operation is enabled.";
            reference
              "ITU-T G.997.2 clause T.3.1 (ANNEX_X_ENABLED),
              ITU-T G.9701 clause X.6.8.1";
    
          }
    
          leaf annex-d-enabled {
            if-feature bbf-fast:annex-d;
            type boolean;
            description
              "Indicates whether Annex D operation is enabled.";
            reference
              "ITU-T G.997.2 clause T.3.3 (ANNEX_D_ENABLED);
              ITU-T G.9701 clause D.5.8.1";
    
          }
    
          leaf idta-enabled {
            if-feature (bbf-fast:dta and bbf-fast:annex-x);
            type boolean;
            description
              "Indicates whether independent Dynamic Time Assignment (iDTA)
    is enabled.";
            reference
              "ITU-T G.9701 clause T.3.2 (DTA_ENABLED);
              ITU-T G.9701 clause X.6.8.2";
    
          }
    
          leaf cdta-procedure-actual-type {
            if-feature (bbf-fast:dta and bbf-fast:annex-d);
            type enumeration {
              enum "disabled" {
                value 0;
                description
                  "Coordinated Dynamic Time Assignment (cDTA) is disabled.";
              }
              enum "one-step" {
                value 1;
                description
                  "Dynamic Resource Allocation (DRA) uses one-step
    Coordinated Dynamic Time Assignment (cDTA)
    procedure.";
              }
              enum "two-step" {
                value 2;
                description
                  "Dynamic Resource Allocation (DRA) uses two-step
    Coordinated Dynamic Time Assignment (cDTA) procedure.";
              }
            }
            description
              "Indicates which Coordinated Dynamic Time Assignment (cDTA)
    procedure is used by the Dynamic Resource Allocation (DRA)
    according to Annex D.";
            reference
              "ITU-T G.997.2 clause T.3.4 (CDTA_PROC_ACT);
              ITU-T G.9701 clause D.5.8.2";
    
          }
    
          container ftu-o {
            description
              "Line status parameters associated with the Fast
    Transceiver Unit - central Office (FTU-O) (Near End).";
            container update-test {
              description
                "Test update parameters.";
              uses line-ftu-update-test;
            }  // container update-test
    
            container failures {
              description
                "Failure related status.";
              leaf line-initialization-failure {
                type boolean;
                description
                  "When the transmitter enters the SILENT state and fails to
    reach the SHOWTIME state (after a vendor discretionary
    number of retries and/or within a vendor discretionary
    timeout), then an initialization failure occurs. An
    initialization failure cause and last successful
    transmitted state are reported.";
                reference
                  "ITU-T G.997.2 clauses 7.4.3 (LINIT) and 7.10.2";
    
              }
    
              uses line-ftu-failure-parameters;
            }  // container failures
          }  // container ftu-o
    
          container ftu-r {
            description
              "Line status parameters associated with the Fast
    Transceiver Unit - Remote side (FTU-R) (Far End).";
            container update-test {
              description
                "Test update parameters.";
              uses line-ftu-update-test;
            }  // container update-test
    
            container failures {
              description
                "Failure related status.";
              uses line-ftu-failure-parameters;
            }  // container failures
    
            leaf minimum-mds-supported {
              type uint8 {
                range "0 | 5..10";
              }
              description
                "If Annex D is enabled (see clause T.3.3), it reports the
    minimal Mds for use in cDTA supported by the FTU-R.
    Otherwise, a special value (0) is reported.";
              reference
                "ITU-T G.997.2 clause T.3.5";
    
            }
          }  // container ftu-r
    
          container downstream {
            description
              "Line status parameters associated with the downstream
    direction.";
            leaf initialization-last-transmitted-signal {
              type uint8 {
                range "0..21";
              }
              description
                "Reports the downstream signal count of the last transmitted
    initialization signal in the last full or short
    initialization performed on the line.";
              reference
                "ITU-T G.997.2 clause 7.10.2.2 (INITLASTSIGNALds);
                ITU-T G.9701 clause 12.3.1";
    
            }
    
            leaf actual-minimum-mds {
              if-feature bbf-fast:dta;
              type uint8 {
                range "5..31";
              }
              description
                "Reports the actual minimum number of downstream symbol
    positions Mds (Act_min_M ds) needed to provide an expected
    downstream throughput of at least DTA_MINETRds.";
              reference
                "ITU-T G.997.2 clause T.5.3.1 (DTA_ACTMINMds);
                ITU-T G.9701 clause T.2.10";
    
            }
    
            leaf actual-maximum-mds {
              if-feature bbf-fast:dta;
              type uint8 {
                range "5..31";
              }
              description
                "Reports the actual maximum number of downstream symbol
    positions Mds (Act_max_M ds) needed to provide an expected
    upstream throughput of at least DTA_MINETRus.";
              reference
                "ITU-T G.997.2 clause T.5.3.2 (DTA_ACTMAXMds);
                ITU-T G.9701 clause T.2.10";
    
            }
    
            uses line-status-parameters;
    
            uses aln-parameters;
    
            uses xlog-parameters;
    
            container time-stamps {
              description
                "Time stamps of certain status parameters.";
              uses line-time-stamps;
    
              leaf time-stamp-last-successful-tiga {
                type time-stamp-or-undefined;
                description
                  "Reports the date/time of the last successful FAST
    Transceiver Unit - central Office (FTU-O) initiated
    Transmitter-Initiated Gain Adjustment (TIGA)
    execution.";
                reference
                  "ITU-T G.997.2 clause 7.10.14.9 (STAMP-TIGA);
                  ITU-T G.9701 clause 11.2.2.5";
    
              }
    
              leaf time-stamp-last-successful-srec {
                if-feature bbf-fast:srec;
                type time-stamp-or-undefined;
                description
                  "Reports the date/time of the last successful FAST
    Transceiver Unit - central Office (FTU-O) initiated
    (local or remote) Showtime Reconfiguration (SREC)
    execution.";
                reference
                  "ITU-T G.997.2 clause 7.10.14.10 (STAMP-SREC);
                  ITU-T G.9701 Annex R";
    
              }
            }  // container time-stamps
          }  // container downstream
    
          container upstream {
            description
              "Line status parameters associated with the downstream
    direction.";
            leaf initialization-last-received-signal {
              type uint8 {
                range "0..10";
              }
              description
                "Reports the upstream signal count of the last transmitted
    initialization signal in the last full or short
    initialization performed on the line.";
              reference
                "ITU-T G.997.2 clause 7.10.2.3 (INITLASTSIGNALus);
                ITU-T G.9701 clause 12.3.1";
    
            }
    
            uses line-status-parameters;
    
            container time-stamps {
              description
                "Time stamps of certain status parameters.";
              uses line-time-stamps;
            }  // container time-stamps
          }  // container upstream
        }  // grouping line-status
      }  // submodule bbf-fast-line-status-body
    

© 2023 YumaWorks, Inc. All rights reserved.